Filter
Top Products
Extensible Firmware Interface Specification
15-72 12/01/02 Version 1.10
EFI_BIS.Initialize()
Summary
Initializes the BIS service, checking that it is compatible with the version requested by the caller.
After this call, other BIS functions may be invoked.
Prototype
typedef
EFI_STATUS
(EFIAPI *EFI_BIS_INITIALIZE)(
IN EFI_BIS_PROTOCOL *This,
OUT BIS_APPLICATION_HANDLE *AppHandle,
IN OUT EFI_BIS_VERSION *InterfaceVersion,
IN EFI_BIS_DATA *TargetAddress
);
Parameters
This A pointer to the EFI_BIS_PROTOCOL object. The protocol
implementation may rely on the actual pointer value and object location,
so the caller must not copy the object to a new location.
AppHandle The function writes the new BIS_APPLICATION_HANDLE
if
successful, otherwise it writes NULL. The caller must eventually destroy
this handle by calling Shutdown()
.Type
BIS_APPLICATION_HANDLE is defined in “Related Definitions”
below.
InterfaceVersion
On input, the caller supplies the major version number of the interface
version desired. The minor version number supplied on input is ignored
since interface compatibility is determined solely by the major version
number. On output, both the major and minor version numbers are
updated with the major and minor version numbers of the interface (and
underlying implementation). This update is done whether or not the
initialization was successful. Type EFI_BIS_VERSION is defined in
“Related Definitions” below.
TargetAddress Indicates a network or device address of the BIS platform to connect to.
Local-platform BIS implementations require that the caller sets
TargetAddress.Data to NULL, but otherwise ignores this
parameter. BIS implementations that redirect calls to an agent at a
remote address must define their own format and interpretation of this
parameter outside the scope of this document. For all implementations,
if the TargetAddress is an unsupported value, the function fails with
the error EFI_UNSUPPORTED.TypeEFI_BIS_DATA is defined in
“Related Definitions” below.