Intel Extensible Firmware Interface - Manual (Page 684)

Extensible Firmware Interface Specification
15-78 12/01/02 Version 1.10
EFI_BIS.Free()
Summary
Frees memory structures allocated and returned by other functions in the EFI_BIS protocol.
Prototype
typedef
EFI_STATUS
(EFIAPI *EFI_BIS_FREE)(
IN BIS_APPLICATION_HANDLE
AppHandle,
IN EFI_BIS_DATA * ToFree
);
Parameters
AppHandle An opaque handle that identifies the caller’s instance of initialization of
the BIS service. Type
BIS_APPLICATION_HANDLE is defined in the
Initialize() function description.
ToFree An EFI_BIS_DATA* and associated memory block to be freed. This
EFI_BIS_DATA* must have been allocated by one of the other BIS
functions. Type EFI_BIS_DATA is defined in the Initialize()
function description.
Description
This function deallocates an EFI_BIS_DATA* and associated memory allocated by one of the
other BIS functions.
Callers of other BIS functions that allocate memory in the form of an EFI_BIS_DATA* must
eventually call this function to deallocate the memory before calling the Shutdown() function for
the application handle under which the memory was allocated. Failure to do so causes unspecified
results, and the continued correct operation of the BIS service cannot be guaranteed.
Status Codes Returned
EFI_SUCCESS The function completed successfully.
EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
EFI_INVALID_PARAMETER The ToFree parameter is not or is no longer a memory resource
associated with this AppHandle .
EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources.