[mirror_edk2.git] / MdeModulePkg / Library / UefiHiiLib / HiiString.c

/** @file\r
  HII Library implementation that uses DXE protocols and services.\r
\r
  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
  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
\r
#include "InternalHiiLib.h"\r
\r
/**\r
  This function create a new string in String Package or updates an existing \r
  string in a String Package.  If StringId is 0, then a new string is added to\r
  a String Package.  If StringId is not zero, then a string in String Package is\r
  updated.  If SupportedLanguages is NULL, then the string is added or updated\r
  for all the languages that the String Package supports.  If SupportedLanguages\r
  is not NULL, then the string is added or updated for the set of languages \r
  specified by SupportedLanguages.\r
    \r
  If HiiHandle is NULL, then ASSERT().\r
  If String is NULL, then ASSERT().\r
\r
  @param[in]  HiiHandle           A handle that was previously registered in the \r
                                  HII Database.\r
  @param[in]  StringId            If zero, then a new string is created in the \r
                                  String Package associated with HiiHandle.  If \r
                                  non-zero, then the string specified by StringId \r
                                  is updated in the String Package  associated \r
                                  with HiiHandle. \r
  @param[in]  String              A pointer to the Null-terminated Unicode string \r
                                  to add or update in the String Package associated \r
                                  with HiiHandle.\r
  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string of \r
                                  language codes.  If this parameter is NULL, then \r
                                  String is added or updated in the String Package \r
                                  associated with HiiHandle for all the languages \r
                                  that the String Package supports.  If this \r
                                  parameter is not NULL, then then String is added \r
                                  or updated in the String Package associated with \r
                                  HiiHandle for the set oflanguages specified by \r
                                  SupportedLanguages.  The format of \r
                                  SupportedLanguages must follow the language \r
                                  format assumed the HII Database.\r
\r
  @retval 0      The string could not be added or updated in the String Package.\r
  @retval Other  The EFI_STRING_ID of the newly added or updated string.\r
\r
**/\r
EFI_STRING_ID\r
EFIAPI\r
HiiSetString (\r
  IN EFI_HII_HANDLE    HiiHandle,\r
  IN EFI_STRING_ID     StringId,            OPTIONAL\r
  IN CONST EFI_STRING  String,\r
  IN CONST CHAR8       *SupportedLanguages  OPTIONAL\r
  )\r
{\r
  EFI_STATUS     Status;\r
  CHAR8          *AllocatedLanguages;\r
  CHAR8          *Supported;\r
  CHAR8          *Language;\r
\r
  ASSERT (HiiHandle != NULL);\r
  ASSERT (String != NULL);\r
\r
  if (SupportedLanguages == NULL) {\r
    //\r
    // Retrieve the languages that the package specified by HiiHandle supports\r
    //\r
    AllocatedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
  } else {\r
    //\r
    // Allocate a copy of the SupportLanguages string that passed in\r
    //\r
    AllocatedLanguages = AllocateCopyPool (AsciiStrSize (SupportedLanguages), SupportedLanguages);\r
  }\r
\r
  //\r
  // If there are not enough resources for the supported languages string, then return a StringId of 0\r
  //\r
  if (AllocatedLanguages == NULL) {\r
    return (EFI_STRING_ID)(0);\r
  }\r
\r
  Status = EFI_INVALID_PARAMETER;\r
  //\r
  // Loop through each language that the string supports\r
  //\r
  for (Supported = AllocatedLanguages; *Supported != '\0'; ) {\r
    //\r
    // Cache a pointer to the beginning of the current language in the list of languages\r
    //\r
    Language = Supported;\r
\r
    //\r
    // Search for the next language seperator and replace it with a Null-terminator\r
    //\r
    for (; *Supported != 0 && *Supported != ';'; Supported++);\r
    if (*Supported != 0) {\r
      *(Supported++) = '\0';\r
    }\r
\r
    //\r
    // If StringId is 0, then call NewString().  Otherwise, call SetString()\r
    //\r
    if (StringId == (EFI_STRING_ID)(0)) {\r
      Status = gHiiString->NewString (gHiiString, HiiHandle, &StringId, Language, NULL, String, NULL);\r
    } else {\r
      Status = gHiiString->SetString (gHiiString, HiiHandle, StringId, Language, String, NULL);\r
    }\r
\r
    //\r
    // If there was an error, then break out of the loop and return a StringId of 0\r
    //\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
  }\r
\r
  //\r
  // Free the buffer of supported languages\r
  //\r
  FreePool (AllocatedLanguages);\r
\r
  if (EFI_ERROR (Status)) {\r
    return (EFI_STRING_ID)(0);\r
  } else {\r
    return StringId;\r
  }\r
}\r
\r
\r
/**\r
  Retrieves a string from a string package names by GUID in a specific language.  \r
  If the language is not specified, then a string from a string package in the \r
  current platform  language is retrieved.  If the string can not be retrieved \r
  using the specified language or the current platform language, then the string \r
  is retrieved from the string package in the first language the string package \r
  supports.  The returned string is allocated using AllocatePool().  The caller \r
  is responsible for freeing the allocated buffer using FreePool().\r
  \r
  If PackageListGuid is NULL, then ASSERT().\r
  If StringId is 0, then ASSERT.\r
\r
  @param[in]  PackageListGuid  The GUID of a package list that was previously \r
                               registered in the HII Database.\r
  @param[in]  StringId         The identifier of the string to retrieved from the \r
                               string package associated with PackageListGuid.\r
  @param[in]  Language         The language of the string to retrieve.  If this \r
                               parameter is NULL, then the current platform \r
                               language is used.  The format of Language must \r
                               follow the language format assumed the HII Database.\r
\r
  @retval NULL   The package list specified by PackageListGuid is not present in the\r
                 HII Database.\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
HiiGetPackageString (\r
  IN CONST EFI_GUID  *PackageListGuid,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL\r
  )\r
{\r
  EFI_HANDLE  *HiiHandleBuffer;\r
  EFI_HANDLE  HiiHandle;\r
\r
  ASSERT (PackageListGuid != NULL);\r
\r
  HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);\r
  if (HiiHandleBuffer == NULL) {\r
    return NULL;\r
  }\r
\r
  HiiHandle = HiiHandleBuffer[0];\r
  FreePool (HiiHandleBuffer);\r
\r
  return HiiGetString (HiiHandle, StringId, Language);\r
}\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 can not 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 ASSET.\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
\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
HiiGetString (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN EFI_STRING_ID   StringId,\r
  IN CONST CHAR8     *Language  OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       StringSize;\r
  CHAR16      TempString;\r
  EFI_STRING  String;\r
  CHAR8       *SupportedLanguages;\r
  CHAR8       *PlatformLanguage;\r
  CHAR8       *BestLanguage;\r
\r
  ASSERT (HiiHandle != NULL);\r
  ASSERT (StringId != 0);\r
\r
  //\r
  // Initialize all allocated buffers to NULL\r
  // \r
  SupportedLanguages = NULL;\r
  PlatformLanguage   = NULL;\r
  BestLanguage       = NULL;\r
  String             = NULL;\r
\r
  //\r
  // Get the languages that the package specified by HiiHandle supports\r
  //\r
  SupportedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
  if (SupportedLanguages == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Get the current platform language setting\r
  //\r
  PlatformLanguage = GetEfiGlobalVariable (L"PlatformLang");\r
\r
  //\r
  // If Languag is NULL, then set it to an empty string, so it will be \r
  // skipped by GetBestLanguage()\r
  //\r
  if (Language == NULL) {\r
    Language = "";\r
  }\r
\r
  //\r
  // Get the best matching language from SupportedLanguages\r
  //\r
  BestLanguage = GetBestLanguage (\r
                   SupportedLanguages, \r
                   FALSE,                                             // RFC 4646 mode\r
                   Language,                                          // Highest priority \r
                   PlatformLanguage != NULL ? PlatformLanguage : "",  // Next highest priority\r
                   SupportedLanguages,                                // Lowest priority \r
                   NULL\r
                   );\r
  if (BestLanguage == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Retrieve the size of the string in the string package for the BestLanguage\r
  //\r
  StringSize = 0;\r
  Status = gHiiString->GetString (\r
                         gHiiString,\r
                         BestLanguage,\r
                         HiiHandle,\r
                         StringId,\r
                         &TempString,\r
                         &StringSize,\r
                         NULL\r
                         );\r
  //\r
  // If GetString() returns EFI_SUCCESS for a zero size, \r
  // then there are no supported languages registered for HiiHandle.  If GetString() \r
  // returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present\r
  // in the HII Database\r
  //\r
  if (Status != EFI_BUFFER_TOO_SMALL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Allocate a buffer for the return string\r
  //\r
  String = AllocateZeroPool (StringSize);\r
  if (String == NULL) {\r
    goto Error;\r
  }\r
\r
  //\r
  // Retrieve the string from the string package\r
  //\r
  Status = gHiiString->GetString (\r
                         gHiiString,\r
                         BestLanguage,\r
                         HiiHandle,\r
                         StringId,\r
                         String,\r
                         &StringSize,\r
                         NULL\r
                         );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Free the buffer and return NULL if the supported languages can not be retrieved.\r
    //\r
    FreePool (String);\r
    String = NULL;\r
  }\r
\r
Error:\r
  //\r
  // Free allocated buffers\r
  //\r
  if (SupportedLanguages != NULL) {\r
    FreePool (SupportedLanguages);\r
  }\r
  if (PlatformLanguage != NULL) {\r
    FreePool (PlatformLanguage);\r
  }\r
  if (BestLanguage != NULL) {\r
    FreePool (BestLanguage);\r
  }\r
\r
  //\r
  // Return the Null-terminated Unicode string\r
  //\r
  return String;\r
}\r
\r
Commit	Line	Data
	1	/** @file\r
	2	HII Library implementation that uses DXE protocols and services.\r
	3	\r
	4	Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	\r
	16	#include "InternalHiiLib.h"\r
	17	\r
	18	/**\r
	19	This function create a new string in String Package or updates an existing \r
	20	string in a String Package. If StringId is 0, then a new string is added to\r
	21	a String Package. If StringId is not zero, then a string in String Package is\r
	22	updated. If SupportedLanguages is NULL, then the string is added or updated\r
	23	for all the languages that the String Package supports. If SupportedLanguages\r
	24	is not NULL, then the string is added or updated for the set of languages \r
	25	specified by SupportedLanguages.\r
	26	\r
	27	If HiiHandle is NULL, then ASSERT().\r
	28	If String is NULL, then ASSERT().\r
	29	\r
	30	@param[in] HiiHandle A handle that was previously registered in the \r
	31	HII Database.\r
	32	@param[in] StringId If zero, then a new string is created in the \r
	33	String Package associated with HiiHandle. If \r
	34	non-zero, then the string specified by StringId \r
	35	is updated in the String Package associated \r
	36	with HiiHandle. \r
	37	@param[in] String A pointer to the Null-terminated Unicode string \r
	38	to add or update in the String Package associated \r
	39	with HiiHandle.\r
	40	@param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of \r
	41	language codes. If this parameter is NULL, then \r
	42	String is added or updated in the String Package \r
	43	associated with HiiHandle for all the languages \r
	44	that the String Package supports. If this \r
	45	parameter is not NULL, then then String is added \r
	46	or updated in the String Package associated with \r
	47	HiiHandle for the set oflanguages specified by \r
	48	SupportedLanguages. The format of \r
	49	SupportedLanguages must follow the language \r
	50	format assumed the HII Database.\r
	51	\r
	52	@retval 0 The string could not be added or updated in the String Package.\r
	53	@retval Other The EFI_STRING_ID of the newly added or updated string.\r
	54	\r
	55	**/\r
	56	EFI_STRING_ID\r
	57	EFIAPI\r
	58	HiiSetString (\r
	59	IN EFI_HII_HANDLE HiiHandle,\r
	60	IN EFI_STRING_ID StringId, OPTIONAL\r
	61	IN CONST EFI_STRING String,\r
	62	IN CONST CHAR8 *SupportedLanguages OPTIONAL\r
	63	)\r
	64	{\r
	65	EFI_STATUS Status;\r
	66	CHAR8 *AllocatedLanguages;\r
	67	CHAR8 *Supported;\r
	68	CHAR8 *Language;\r
	69	\r
	70	ASSERT (HiiHandle != NULL);\r
	71	ASSERT (String != NULL);\r
	72	\r
	73	if (SupportedLanguages == NULL) {\r
	74	//\r
	75	// Retrieve the languages that the package specified by HiiHandle supports\r
	76	//\r
	77	AllocatedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
	78	} else {\r
	79	//\r
	80	// Allocate a copy of the SupportLanguages string that passed in\r
	81	//\r
	82	AllocatedLanguages = AllocateCopyPool (AsciiStrSize (SupportedLanguages), SupportedLanguages);\r
	83	}\r
	84	\r
	85	//\r
	86	// If there are not enough resources for the supported languages string, then return a StringId of 0\r
	87	//\r
	88	if (AllocatedLanguages == NULL) {\r
	89	return (EFI_STRING_ID)(0);\r
	90	}\r
	91	\r
	92	Status = EFI_INVALID_PARAMETER;\r
	93	//\r
	94	// Loop through each language that the string supports\r
	95	//\r
	96	for (Supported = AllocatedLanguages; *Supported != '\0'; ) {\r
	97	//\r
	98	// Cache a pointer to the beginning of the current language in the list of languages\r
	99	//\r
	100	Language = Supported;\r
	101	\r
	102	//\r
	103	// Search for the next language seperator and replace it with a Null-terminator\r
	104	//\r
	105	for (; Supported != 0 && Supported != ';'; Supported++);\r
	106	if (*Supported != 0) {\r
	107	*(Supported++) = '\0';\r
	108	}\r
	109	\r
	110	//\r
	111	// If StringId is 0, then call NewString(). Otherwise, call SetString()\r
	112	//\r
	113	if (StringId == (EFI_STRING_ID)(0)) {\r
	114	Status = gHiiString->NewString (gHiiString, HiiHandle, &StringId, Language, NULL, String, NULL);\r
	115	} else {\r
	116	Status = gHiiString->SetString (gHiiString, HiiHandle, StringId, Language, String, NULL);\r
	117	}\r
	118	\r
	119	//\r
	120	// If there was an error, then break out of the loop and return a StringId of 0\r
	121	//\r
	122	if (EFI_ERROR (Status)) {\r
	123	break;\r
	124	}\r
	125	}\r
	126	\r
	127	//\r
	128	// Free the buffer of supported languages\r
	129	//\r
	130	FreePool (AllocatedLanguages);\r
	131	\r
	132	if (EFI_ERROR (Status)) {\r
	133	return (EFI_STRING_ID)(0);\r
	134	} else {\r
	135	return StringId;\r
	136	}\r
	137	}\r
	138	\r
	139	\r
	140	/**\r
	141	Retrieves a string from a string package names by GUID in a specific language. \r
	142	If the language is not specified, then a string from a string package in the \r
	143	current platform language is retrieved. If the string can not be retrieved \r
	144	using the specified language or the current platform language, then the string \r
	145	is retrieved from the string package in the first language the string package \r
	146	supports. The returned string is allocated using AllocatePool(). The caller \r
	147	is responsible for freeing the allocated buffer using FreePool().\r
	148	\r
	149	If PackageListGuid is NULL, then ASSERT().\r
	150	If StringId is 0, then ASSERT.\r
	151	\r
	152	@param[in] PackageListGuid The GUID of a package list that was previously \r
	153	registered in the HII Database.\r
	154	@param[in] StringId The identifier of the string to retrieved from the \r
	155	string package associated with PackageListGuid.\r
	156	@param[in] Language The language of the string to retrieve. If this \r
	157	parameter is NULL, then the current platform \r
	158	language is used. The format of Language must \r
	159	follow the language format assumed the HII Database.\r
	160	\r
	161	@retval NULL The package list specified by PackageListGuid is not present in the\r
	162	HII Database.\r
	163	@retval NULL The string specified by StringId is not present in the string package.\r
	164	@retval Other The string was returned.\r
	165	\r
	166	**/\r
	167	EFI_STRING\r
	168	EFIAPI\r
	169	HiiGetPackageString (\r
	170	IN CONST EFI_GUID *PackageListGuid,\r
	171	IN EFI_STRING_ID StringId,\r
	172	IN CONST CHAR8 *Language OPTIONAL\r
	173	)\r
	174	{\r
	175	EFI_HANDLE *HiiHandleBuffer;\r
	176	EFI_HANDLE HiiHandle;\r
	177	\r
	178	ASSERT (PackageListGuid != NULL);\r
	179	\r
	180	HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);\r
	181	if (HiiHandleBuffer == NULL) {\r
	182	return NULL;\r
	183	}\r
	184	\r
	185	HiiHandle = HiiHandleBuffer[0];\r
	186	FreePool (HiiHandleBuffer);\r
	187	\r
	188	return HiiGetString (HiiHandle, StringId, Language);\r
	189	}\r
	190	\r
	191	/**\r
	192	Retrieves a string from a string package in a specific language. If the language\r
	193	is not specified, then a string from a string package in the current platform \r
	194	language is retrieved. If the string can not be retrieved using the specified \r
	195	language or the current platform language, then the string is retrieved from \r
	196	the string package in the first language the string package supports. The \r
	197	returned string is allocated using AllocatePool(). The caller is responsible \r
	198	for freeing the allocated buffer using FreePool().\r
	199	\r
	200	If HiiHandle is NULL, then ASSERT().\r
	201	If StringId is 0, then ASSET.\r
	202	\r
	203	@param[in] HiiHandle A handle that was previously registered in the HII Database.\r
	204	@param[in] StringId The identifier of the string to retrieved from the string \r
	205	package associated with HiiHandle.\r
	206	@param[in] Language The language of the string to retrieve. If this parameter \r
	207	is NULL, then the current platform language is used. The \r
	208	format of Language must follow the language format assumed \r
	209	the HII Database.\r
	210	\r
	211	@retval NULL The string specified by StringId is not present in the string package.\r
	212	@retval Other The string was returned.\r
	213	\r
	214	**/\r
	215	EFI_STRING\r
	216	EFIAPI\r
	217	HiiGetString (\r
	218	IN EFI_HII_HANDLE HiiHandle,\r
	219	IN EFI_STRING_ID StringId,\r
	220	IN CONST CHAR8 *Language OPTIONAL\r
	221	)\r
	222	{\r
	223	EFI_STATUS Status;\r
	224	UINTN StringSize;\r
	225	CHAR16 TempString;\r
	226	EFI_STRING String;\r
	227	CHAR8 *SupportedLanguages;\r
	228	CHAR8 *PlatformLanguage;\r
	229	CHAR8 *BestLanguage;\r
	230	\r
	231	ASSERT (HiiHandle != NULL);\r
	232	ASSERT (StringId != 0);\r
	233	\r
	234	//\r
	235	// Initialize all allocated buffers to NULL\r
	236	// \r
	237	SupportedLanguages = NULL;\r
	238	PlatformLanguage = NULL;\r
	239	BestLanguage = NULL;\r
	240	String = NULL;\r
	241	\r
	242	//\r
	243	// Get the languages that the package specified by HiiHandle supports\r
	244	//\r
	245	SupportedLanguages = HiiGetSupportedLanguages (HiiHandle);\r
	246	if (SupportedLanguages == NULL) {\r
	247	goto Error;\r
	248	}\r
	249	\r
	250	//\r
	251	// Get the current platform language setting\r
	252	//\r
	253	PlatformLanguage = GetEfiGlobalVariable (L"PlatformLang");\r
	254	\r
	255	//\r
	256	// If Languag is NULL, then set it to an empty string, so it will be \r
	257	// skipped by GetBestLanguage()\r
	258	//\r
	259	if (Language == NULL) {\r
	260	Language = "";\r
	261	}\r
	262	\r
	263	//\r
	264	// Get the best matching language from SupportedLanguages\r
	265	//\r
	266	BestLanguage = GetBestLanguage (\r
	267	SupportedLanguages, \r
	268	FALSE, // RFC 4646 mode\r
	269	Language, // Highest priority \r
	270	PlatformLanguage != NULL ? PlatformLanguage : "", // Next highest priority\r
	271	SupportedLanguages, // Lowest priority \r
	272	NULL\r
	273	);\r
	274	if (BestLanguage == NULL) {\r
	275	goto Error;\r
	276	}\r
	277	\r
	278	//\r
	279	// Retrieve the size of the string in the string package for the BestLanguage\r
	280	//\r
	281	StringSize = 0;\r
	282	Status = gHiiString->GetString (\r
	283	gHiiString,\r
	284	BestLanguage,\r
	285	HiiHandle,\r
	286	StringId,\r
	287	&TempString,\r
	288	&StringSize,\r
	289	NULL\r
	290	);\r
	291	//\r
	292	// If GetString() returns EFI_SUCCESS for a zero size, \r
	293	// then there are no supported languages registered for HiiHandle. If GetString() \r
	294	// returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present\r
	295	// in the HII Database\r
	296	//\r
	297	if (Status != EFI_BUFFER_TOO_SMALL) {\r
	298	goto Error;\r
	299	}\r
	300	\r
	301	//\r
	302	// Allocate a buffer for the return string\r
	303	//\r
	304	String = AllocateZeroPool (StringSize);\r
	305	if (String == NULL) {\r
	306	goto Error;\r
	307	}\r
	308	\r
	309	//\r
	310	// Retrieve the string from the string package\r
	311	//\r
	312	Status = gHiiString->GetString (\r
	313	gHiiString,\r
	314	BestLanguage,\r
	315	HiiHandle,\r
	316	StringId,\r
	317	String,\r
	318	&StringSize,\r
	319	NULL\r
	320	);\r
	321	if (EFI_ERROR (Status)) {\r
	322	//\r
	323	// Free the buffer and return NULL if the supported languages can not be retrieved.\r
	324	//\r
	325	FreePool (String);\r
	326	String = NULL;\r
	327	}\r
	328	\r
	329	Error:\r
	330	//\r
	331	// Free allocated buffers\r
	332	//\r
	333	if (SupportedLanguages != NULL) {\r
	334	FreePool (SupportedLanguages);\r
	335	}\r
	336	if (PlatformLanguage != NULL) {\r
	337	FreePool (PlatformLanguage);\r
	338	}\r
	339	if (BestLanguage != NULL) {\r
	340	FreePool (BestLanguage);\r
	341	}\r
	342	\r
	343	//\r
	344	// Return the Null-terminated Unicode string\r
	345	//\r
	346	return String;\r
	347	}\r
	348	\r