MdeModulePkg/Library: Add HiiGetStringEx to UefiHiiLib for EDK2 Redfish

[mirror_edk2.git] / MdeModulePkg / Include / Library / HiiLib.h

diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h
index c475cb74a17fde3a51b7cf3e1f2fff170f321d33..cd9027fefd8e38ed4fa558272e9b547413f8c087 100644 (file)
--- a/MdeModulePkg/Include/Library/HiiLib.h
+++ b/MdeModulePkg/Include/Library/HiiLib.h
@@ -1,7 +1,8 @@
 /** @file\r
   Public include file for the HII Library\r
 \r
-Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2021, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
@@ -123,16 +124,8 @@ HiiSetString (
 ;\r
 \r
 /**\r
-  Retrieves a string from a string package in a specific language.  If the language\r
-  is not specified, then a string from a string package in the current platform\r
-  language is retrieved.  If the string cannot be retrieved using the specified\r
-  language or the current platform language, then the string is retrieved from\r
-  the string package in the first language the string package supports.  The\r
-  returned string is allocated using AllocatePool().  The caller is responsible\r
-  for freeing the allocated buffer using FreePool().\r
-\r
-  If HiiHandle is NULL, then ASSERT().\r
-  If StringId is 0, then ASSERT().\r
+  Retrieves a string from a string package in a specific language specified in Language\r
+  or in the best lanaguage. See HiiGetStringEx () for the details.\r
 \r
   @param[in]  HiiHandle  A handle that was previously registered in the HII Database.\r
   @param[in]  StringId   The identifier of the string to retrieved from the string\r
@@ -152,8 +145,49 @@ HiiGetString (
   IN EFI_HII_HANDLE  HiiHandle,\r
   IN EFI_STRING_ID   StringId,\r
   IN CONST CHAR8     *Language  OPTIONAL\r
-  )\r
-;\r
+  );\r
+\r
+/**\r
+  Retrieves a string from a string package in a specific language or in the best\r
+  language at discretion of this function according to the priority of languages.\r
+  TryBestLanguage is used to get the string in the best language or in the language\r
+  specified in Language parameter. The behavior is,\r
+  If TryBestLanguage is TRUE, this function looks for the best language for the string.\r
+   - If the string can not be retrieved using the specified language or the current\r
+     platform language, then the string is retrieved from the string package in the\r
+     first language the string package supports.\r
+  If TryBestLanguage is FALSE, Language must be specified for retrieving the string.\r
+\r
+  The returned string is allocated using AllocatePool().  The caller is responsible\r
+  for freeing the allocated buffer using FreePool().\r
+\r
+  If HiiHandle is NULL, then ASSERT().\r
+  If StringId is 0, then ASSET.\r
+  If TryBestLanguage is FALE and Language is NULL, then ASSERT().\r
+\r
+  @param[in]  HiiHandle         A handle that was previously registered in the HII Database.\r
+  @param[in]  StringId          The identifier of the string to retrieved from the string\r
+                                package associated with HiiHandle.\r
+  @param[in]  Language          The language of the string to retrieve.  If this parameter\r
+                                is NULL, then the current platform language is used.  The\r
+                                format of Language must follow the language format assumed\r
+                                the HII Database.\r
+  @param[in]  TryBestLanguage   If TRUE, try to get the best matching language from all\r
+                                supported languages.If FALSE, the Language must be assigned\r
+                                for the StringID.\r
+\r
+  @retval NULL   The string specified by StringId is not present in the string package.\r
+  @retval Other  The string was returned.\r
+\r
+**/\r
+EFI_STRING\r
+EFIAPI\r
+HiiGetStringEx (\r
+  IN EFI_HII_HANDLE  HiiHandle,\r
+  IN EFI_STRING_ID   StringId,\r
+  IN CONST CHAR8     *Language  OPTIONAL,\r
+  IN BOOLEAN         TryBestLanguage\r
+  );\r
 \r
 /**\r
   Retrieves a string from a string package named by GUID, in the specified language.\r