Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / String.c

/** @file\r
  String support\r
\r
Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "Bds.h"\r
#include "Language.h"\r
#include "FrontPage.h"\r
\r
EFI_HII_HANDLE gStringPackHandle;\r
\r
EFI_GUID mBdsStringPackGuid = {\r
  0x7bac95d3, 0xddf, 0x42f3, {0x9e, 0x24, 0x7c, 0x64, 0x49, 0x40, 0x37, 0x9a}\r
};\r
\r
/**\r
  Initialize HII global accessor for string support\r
\r
**/\r
VOID\r
InitializeStringSupport (\r
  VOID\r
  )\r
{\r
  gStringPackHandle = HiiAddPackages (\r
                         &mBdsStringPackGuid,\r
                         mBdsImageHandle,\r
                         BdsDxeStrings,\r
                         NULL\r
                         );\r
  ASSERT (gStringPackHandle != NULL);\r
}\r
\r
/**\r
  Get string by string id from HII Interface\r
\r
\r
  @param Id              String ID.\r
\r
  @retval  CHAR16 *  String from ID.\r
  @retval  NULL      If error occurs.\r
\r
**/\r
CHAR16 *\r
GetStringById (\r
  IN  EFI_STRING_ID   Id\r
  )\r
{\r
  return HiiGetString (gStringPackHandle, Id, NULL);\r
}\r