SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
7.1.3 EFI_HII_PROTOCOL.FindHandles()
Summary
Determines the handles that are currently active in the database.
Prototype
EFI_STATUS
(EFIAPI *EFI_HII_FIND_HANDLES) (
IN EFI_HII_PROTOCOL *This,
IN OUT UINT16
*HandleBufferLength,
OUT EFI_HII_HANDLE *Handle
);
Parameters
This
HandleBufferLength
Handle
A pointer to the EFI_HII_PROTOCOL instance.
A pointer to the length of the handle buffer on input. On output the
actual number of handles.
An array of EFI_HII_HANDLE instances returned.
Description
Determines the handles that are currently active in the database. As an example of use, a program
wishing to create a Setup-like configuration utility would use this call to determine the handles
available. It would then use calls defined in the forms section below to extract forms and then interpret
them.
Status Codes Returned
EFI_SUCCESS
EFI_BUFFER_TOO_SMALL
Handles[] updated successfully.
The HandleBufferLength parameter indicates that Handle[] is too
small to support the number of handles. HandleBufferLength is
updated with a value that will enable the data to fit.
54