IntelFrameworkModulePkg/Universal/BdsDxe/String.h

   1 /** @file
   2   String support
   3
   4 Copyright (c) 2004 - 2009, 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 #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   Get string by string id from HII Interface
  31
  32
  33   @param Id              String ID.
  34
  35   @retval  CHAR16 *  String from ID.
  36   @retval  NULL      If error occurs.
  37
  38 **/
  39 CHAR16 *
  40 GetStringById (
  41   IN  EFI_STRING_ID   Id
  42   );
  43
  44 /**
  45   Initialize HII global accessor for string support.
  46
  47 **/
  48 VOID
  49 InitializeStringSupport (
  50   VOID
  51   );
  52
  53 /**
  54   Call the browser and display the front page
  55
  56   @return   Status code that will be returned by
  57             EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
  58
  59 **/
  60 EFI_STATUS
  61 CallFrontPage (
  62   VOID
  63   );
  64
  65 #endif // _STRING_H_