MdeModulePkg/Universal/BdsDxe/String.h

   1 /** @file
   2   String support
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. 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 #include "Bds.h"
  19
  20 extern EFI_HII_HANDLE gStringPackHandle;
  21
  22 //
  23 // This is the VFR compiler generated header file which defines the
  24 // string identifiers.
  25 //
  26
  27 extern UINT8  BdsDxeStrings[];
  28
  29 //
  30 // String Definition Guid for BDS Platform
  31 //
  32 #define EFI_BDS_PLATFORM_GUID \
  33   { \
  34     0x7777E939, 0xD57E, 0x4DCB, 0xA0, 0x8E, 0x64, 0xD7, 0x98, 0x57, 0x1E, 0x0F \
  35   }
  36
  37 /**
  38   Get string by string id from HII Interface
  39
  40
  41   @param Id              String ID.
  42
  43   @retval  CHAR16 *  String from ID.
  44   @retval  NULL      If error occurs.
  45
  46 **/
  47 CHAR16 *
  48 GetStringById (
  49   IN  EFI_STRING_ID   Id
  50   );
  51
  52 /**
  53   Initialize HII global accessor for string support
  54
  55   @retval  EFI_SUCCESS  String support initialize success.
  56
  57 **/
  58 EFI_STATUS
  59 InitializeStringSupport (
  60   VOID
  61   );
  62
  63 /**
  64   Call the browser and display the front page
  65
  66   @return   Status code that will be returned by
  67             EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
  68
  69 **/
  70 EFI_STATUS
  71 CallFrontPage (
  72   VOID
  73   );
  74
  75 #endif // _STRING_H_