#include <Uefi.h>
#include <Library/UefiHiiServicesLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Protocol/HiiFont.h>
#include <Protocol/HiiString.h>
#include <Protocol/HiiImage.h>
#include <Protocol/HiiDatabase.h>
#include <Protocol/HiiConfigRouting.h>

Functions
EFI_STATUS EFIAPI	UefiHiiServicesLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_HII_FONT_PROTOCOL *	gHiiFont = NULL

EFI_HII_STRING_PROTOCOL *	gHiiString = NULL

EFI_HII_IMAGE_PROTOCOL *	gHiiImage = NULL

EFI_HII_DATABASE_PROTOCOL *	gHiiDatabase = NULL

EFI_HII_CONFIG_ROUTING_PROTOCOL *	gHiiConfigRouting = NULL

Detailed Description

This library retrieves pointers to the UEFI HII Protocol instances in the library's constructor. All of the UEFI HII related protocols are optional, so the consumers of this library class must verify that the global variable pointers are not NULL before use.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UefiHiiServicesLib.c.

Function Documentation

◆ UefiHiiServicesLibConstructor()

EFI_STATUS EFIAPI UefiHiiServicesLibConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The constructor function retrieves pointers to the UEFI HII protocol instances

The constructor function retrieves pointers to the four UEFI HII protocols from the handle database. These include the UEFI HII Font Protocol, the UEFI HII String Protocol, the UEFI HII Image Protocol, the UEFI HII Database Protocol, and the UEFI HII Config Routing Protocol. This function always return EFI_SUCCESS. All of these protocols are optional if the platform does not support configuration and the UEFI HII Image Protocol and the UEFI HII Font Protocol are optional if the platform does not support a graphical console. As a result, the consumers of this library much check the protocol pointers againt NULL before using them, or use dependency expressions to guarantee that some of them are present before assuming they are not NULL.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The constructor always returns EFI_SUCCESS.

Definition at line 71 of file UefiHiiServicesLib.c.

Variable Documentation

◆ gHiiConfigRouting

EFI_HII_CONFIG_ROUTING_PROTOCOL* gHiiConfigRouting = NULL

Pointer to the UEFI HII Config Rounting Protocol

Definition at line 47 of file UefiHiiServicesLib.c.

◆ gHiiDatabase

EFI_HII_DATABASE_PROTOCOL* gHiiDatabase = NULL

Pointer to the UEFI HII Database Protocol

Definition at line 42 of file UefiHiiServicesLib.c.

◆ gHiiFont

EFI_HII_FONT_PROTOCOL* gHiiFont = NULL

Pointer to the UEFI HII Font Protocol

Definition at line 27 of file UefiHiiServicesLib.c.

◆ gHiiImage

EFI_HII_IMAGE_PROTOCOL* gHiiImage = NULL

Pointer to the UEFI HII Image Protocol

Definition at line 37 of file UefiHiiServicesLib.c.

◆ gHiiString

EFI_HII_STRING_PROTOCOL* gHiiString = NULL

Pointer to the UEFI HII String Protocol

Definition at line 32 of file UefiHiiServicesLib.c.

Functions

Variables