SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
7.1.11 EFI_HII_PROTOCOL.GetForms()
Summary
This function allows a program to extract a form or form package that has previously been registered
with the EFI HII database.
Prototype
EFI_STATUS
(EFIAPI *EFI_HII_GET_FORMS) (
IN EFI_HII_PROTOCOL *This,
IN EFI_HII_HANDLE Handle,
IN EFI_FORM_ID FormId,
IN OUT UINT16
*BufferLength,
OUT UINT8 *Buffer
);
Parameters
This
Handle
FormId
BufferLength
Buffer
A pointer to the EFI_HII_PROTOCOL instance.
Handle on which the form resides.
The id of the form to return. If the id is zero, the entire form package
is returned.
On input, the length of the Buffer. On output, the length of the
returned buffer, if the length was sufficient and, if it was not, the
length that is required to fit the requested form(s).
The buffer designed to receive the form(s).
Description
This function is used to extract a form or forms
Status Codes Returned
EFI_SUCCESS
EFI_INVALID_PARAMETER
EFI_NOT_FOUND
EFI_BUFFER_TOO_SMALL
Buffer filled with the requested forms.
BufferLength updated.
Unknown handle.
A form on the requested handle cannot be found with the
requested FormId.
The buffer provided was not large enough to allow the
form to be stored.
64