iPXE
Data Structures | Macros | Functions | Variables
FileInfo.h File Reference

Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo() and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information. More...

Go to the source code of this file.

Data Structures

struct  EFI_FILE_INFO
 

Macros

#define EFI_FILE_INFO_ID
 
#define SIZE_OF_EFI_FILE_INFO   OFFSET_OF (EFI_FILE_INFO, FileName)
 The FileName field of the EFI_FILE_INFO data structure is variable length. More...
 

Functions

 FILE_LICENCE (BSD2_PATENT)
 

Variables

EFI_GUID gEfiFileInfoGuid
 

Detailed Description

Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo() and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.

This GUID is defined in UEFI specification.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file FileInfo.h.

Macro Definition Documentation

◆ EFI_FILE_INFO_ID

#define EFI_FILE_INFO_ID
Value:
{ \
0x9576e92, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
}

Definition at line 16 of file FileInfo.h.

◆ SIZE_OF_EFI_FILE_INFO

#define SIZE_OF_EFI_FILE_INFO   OFFSET_OF (EFI_FILE_INFO, FileName)

The FileName field of the EFI_FILE_INFO data structure is variable length.

Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to be the size of the data structure without the FileName field. The following macro computes this size correctly no matter how big the FileName array is declared. This is required to make the EFI_FILE_INFO data structure ANSI compilant.

Definition at line 64 of file FileInfo.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT  )

Variable Documentation

◆ gEfiFileInfoGuid

EFI_GUID gEfiFileInfoGuid