MdeModulePkg/Application/UiApp/String.h

   1 /** @file
   2   String support
   3
   4 Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _STRING_H_
  16 #define _STRING_H_
  17
  18 extern EFI_HII_HANDLE gStringPackHandle;
  19
  20 //
  21 // This is the VFR compiler generated header file which defines the
  22 // string identifiers.
  23 //
  24
  25 extern UINT8  BdsDxeStrings[];
  26
  27 //
  28 // String Definition Guid for BDS Platform
  29 //
  30 #define EFI_BDS_PLATFORM_GUID \
  31   { \
  32     0x7777E939, 0xD57E, 0x4DCB, 0xA0, 0x8E, 0x64, 0xD7, 0x98, 0x57, 0x1E, 0x0F \
  33   }
  34
  35 /**
  36   Get string by string id from HII Interface
  37
  38
  39   @param Id              String ID.
  40
  41   @retval  CHAR16 *  String from ID.
  42   @retval  NULL      If error occurs.
  43
  44 **/
  45 CHAR16 *
  46 GetStringById (
  47   IN  EFI_STRING_ID   Id
  48   );
  49
  50 /**
  51   Initialize HII global accessor for string support.
  52
  53 **/
  54 VOID
  55 InitializeStringSupport (
  56   VOID
  57   );
  58
  59 /**
  60   Remove the string package.
  61
  62 **/
  63 VOID
  64 UninitializeStringSupport (
  65   VOID
  66   );
  67
  68 /**
  69   Call the browser and display the front page
  70
  71   @return   Status code that will be returned by
  72             EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
  73
  74 **/
  75 EFI_STATUS
  76 CallFrontPage (
  77   VOID
  78   );
  79
  80 #endif // _STRING_H_