Filter
Top Products
Extensible Firmware Interface Specification
11-30 12/01/02 Version 1.10
EFI_FILE.GetInfo()
Summary
Returns information about a file.
Prototype
EFI_STATUS
(EFIAPI *EFI_FILE_GET_INFO) (
IN EFI_FILE *This,
IN EFI_GUID *InformationType,
IN OUT UINTN *BufferSize,
OUT VOID *Buffer
);
Parameters
This A pointer to the EFI_FILE instance that is the file handle the requested
information is for. See the type EFI_FILE protocol description.
InformationType The type identifier for the information being requested. Type
EFI_GUID
is defined in Chapter 5. See the EFI_FILE_INFO and
EFI_FILE_SYSTEM_INFO
descriptions for the related GUID
definitions.
BufferSize On input, the size of Buffer. On output, the amount of data returned in
Buffer. In both cases, the size is measured in bytes.
Buffer A pointer to the data buffer to return. The buffer’s type is indicated by
InformationType.
Description
The GetInfo() function returns information of type InformationType for the requested file.
If the file does not support the requested information type, then EFI_UNSUPPORTED is returned.
If the buffer is not large enough to fit the requested structure, EFI_BUFFER_TOO_SMALL is
returned and the BufferSize is set to the size of buffer that is required to make the request.
The information types defined by this specification are required information types that all file
systems must support.
Status Codes Returned
EFI_SUCCESS The information was set.
EFI_UNSUPPORTED
The
InformationType is not known.
EFI_NO_MEDIA The device has no medium.
EFI_DEVICE_ERROR The device reported an error.
EFI_VOLUME_CORRUPTED The file system structures are corrupted.
EFI_BUFFER_TOO_SMALL
The
BufferSize is too small to read the current directory entry.
BufferSize has been updated with the size needed to complete the
request.