4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Language related HII Library implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a pointer to the a Null-terminated ASCII string containing the list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of languages that an HII handle in the HII Database supports. The returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string is allocated using AllocatePool(). The caller is responsible for freeing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the returned string using FreePool(). The format of the returned string follows
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the language format assumed the HII Database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If HiiHandle is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HiiHandle A handle that was previously registered in the HII Database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL HiiHandle is not registered in the HII database
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL There are not enough resources available to retrieve the suported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL The list of suported languages could not be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Other A pointer to the Null-terminated ASCII string of supported languages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the size required for the supported languages buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gHiiString->GetLanguages (gHiiString, HiiHandle, &TempSupportedLanguages, &LanguageSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If GetLanguages() returns EFI_SUCCESS for a zero size,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // then there are no supported languages registered for HiiHandle. If GetLanguages()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // in the HII Database
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return NULL if the size can not be retrieved, or if HiiHandle is not in the HII Database
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate the supported languages buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SupportedLanguages = AllocateZeroPool (LanguageSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return NULL if allocation fails.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the supported languages string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gHiiString->GetLanguages (gHiiString, HiiHandle, SupportedLanguages, &LanguageSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Free the buffer and return NULL if the supported languages can not be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return the Null-terminated ASCII string of supported languages