4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This library retrieves pointers to the UEFI HII Protocol instances in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync library's constructor. All of the UEFI HII related protocols are optional,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync so the consumers of this library class must verify that the global variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointers are not NULL before use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pointer to the UEFI HII Font Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pointer to the UEFI HII String Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pointer to the UEFI HII Image Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pointer to the UEFI HII Database Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pointer to the UEFI HII Config Rounting Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_HII_CONFIG_ROUTING_PROTOCOL *gHiiConfigRouting = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The constructor function retrieves pointers to the UEFI HII protocol instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The constructor function retrieves pointers to the four UEFI HII protocols from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle database. These include the UEFI HII Font Protocol, the UEFI HII String
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol, the UEFI HII Image Protocol, the UEFI HII Database Protocol, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI HII Config Routing Protocol. This function always return EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All of these protocols are optional if the platform does not support configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the UEFI HII Image Protocol and the UEFI HII Font Protocol are optional if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the platform does not support a graphical console. As a result, the consumers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of this library much check the protocol pointers againt NULL before using them,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or use dependency expressions to guarantee that some of them are present before
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync assuming they are not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The firmware allocated handle for the EFI image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SystemTable A pointer to the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the pointer to the UEFI HII String Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &gHiiString);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the pointer to the UEFI HII Database Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &gHiiDatabase);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the pointer to the UEFI HII Config Routing Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &gHiiConfigRouting);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the pointer to the optional UEFI HII Font Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->LocateProtocol (&gEfiHiiFontProtocolGuid, NULL, (VOID **) &gHiiFont);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the pointer to the optional UEFI HII Image Protocol