Intel Extensible Firmware Interface - Manual (Page 687)

Protocols — Network Support
Version 1.10 12/01/02 15-81
EFI_BIS.GetBootObjectAuthorizationUpdateToken()
Summary
Retrieves a unique token value to be included in the request credential for the next update of any
parameter in the Boot Object Authorization set (Boot Object Authorization Certificate and Boot
Authorization Check Flag).
Prototype
typedef
EFI_STATUS
(EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_UPDATE_TOKEN)(
IN BIS_APPLICATION_HANDLE
AppHandle,
OUT EFI_BIS_DATA **UpdateToken
);
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.
UpdateToken The function writes an allocated EFI_BIS_DATA* containing the new
unique update token value. The caller must eventually free the memory
allocated by this function using the function
Free() . Type
EFI_BIS_DATA is defined in the Initialize() function
description.
Description
This function retrieves a unique token value to be included in the request credential for the next
update of any parameter in the Boot Object Authorization set (Boot Object Authorization
Certificate and Boot Authorization Check Flag). The token value is unique to this platform,
parameter set, and instance of parameter values. In particular, the token changes to a new unique
value whenever any parameter in this set is changed.
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_OUT_OF_RESOURCES The function failed due to lack of memory or other resources.
EFI_DEVICE_ERROR The function encountered an unexpected internal error in a
cryptographic software module.
EFI_INVALID_PARAMETER The UpdateToken parameter supplied by the caller is NULL or
an invalid memory reference.