MdeModulePkg/Include/Library/UefiHiiServicesLib.h

   1 /** @file
   2   Provides global variables that are pointers to the UEFI HII related protocols.
   3   All of the UEFI HII related protocols are optional, so the consumers of this
   4   library class must verify that the global variable pointers are not NULL before
   5   use.
   6
   7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   8 This program and the accompanying materials are licensed and made available under
   9 the terms and conditions of the BSD License that accompanies this distribution.
  10 The full text of the license may be found at
  11 http://opensource.org/licenses/bsd-license.php.
  12
  13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef __UEFI_HII_SERVICES_LIB_H__
  19 #define __UEFI_HII_SERVICES_LIB_H__
  20
  21 #include <Protocol/HiiFont.h>
  22 #include <Protocol/HiiString.h>
  23 #include <Protocol/HiiImage.h>
  24 #include <Protocol/HiiDatabase.h>
  25 #include <Protocol/HiiConfigRouting.h>
  26
  27 ///
  28 /// The pointer to the UEFI HII Font Protocol.
  29 ///
  30 extern EFI_HII_FONT_PROTOCOL  *gHiiFont;
  31
  32 ///
  33 /// The pointer to the UEFI HII String Protocol.
  34 ///
  35 extern EFI_HII_STRING_PROTOCOL  *gHiiString;
  36
  37 ///
  38 /// The pointer to the UEFI HII Image Protocol.
  39 ///
  40 extern EFI_HII_IMAGE_PROTOCOL  *gHiiImage;
  41
  42 ///
  43 /// The pointer to the UEFI HII Database Protocol.
  44 ///
  45 extern EFI_HII_DATABASE_PROTOCOL  *gHiiDatabase;
  46
  47 ///
  48 /// The pointer to the UEFI HII Config Rounting Protocol.
  49 ///
  50 extern EFI_HII_CONFIG_ROUTING_PROTOCOL  *gHiiConfigRouting;
  51
  52 #endif