diff options
author | lzeng14 <lzeng14@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-06-08 05:53:18 +0000 |
---|---|---|
committer | lzeng14 <lzeng14@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-06-08 05:53:18 +0000 |
commit | 4f0779023cb4f633425a6fa8df747326336f2077 (patch) | |
tree | b4b886d425bb25ddd135777f46264f493b9a841e /MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h | |
parent | 8052c4a2b9e0c3575e912e5867cd0d7c2669c925 (diff) | |
download | edk2-platforms-4f0779023cb4f633425a6fa8df747326336f2077.tar.xz |
String Reference Cleanup.
Signed-off-by: lzeng14
Reviewed-by: lgao4
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11762 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h')
-rw-r--r-- | MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h index d4f730abb8..1f6b888ec5 100644 --- a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h +++ b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h @@ -1060,7 +1060,8 @@ HiiSetString ( @param This A pointer to the EFI_HII_STRING_PROTOCOL
instance.
@param PackageList The package list to examine.
- @param Languages Points to the buffer to hold the returned string.
+ @param Languages Points to the buffer to hold the returned
+ null-terminated ASCII string.
@param LanguagesSize On entry, points to the size of the buffer
pointed to by Languages, in bytes. On return,
points to the length of Languages, in bytes.
@@ -1092,25 +1093,28 @@ HiiGetLanguages ( @param This A pointer to the EFI_HII_STRING_PROTOCOL
instance.
@param PackageList The package list to examine.
- @param FirstLanguage Points to the primary language.
- @param SecondaryLanguages Points to the buffer to hold the returned list of
- secondary languages for the specified
- FirstLanguage. If there are no secondary
- languages, the function returns successfully,
+ @param PrimaryLanguage Points to the null-terminated ASCII string that specifies
+ the primary language. Languages are specified in the
+ format specified in Appendix M of the UEFI 2.0 specification.
+ @param SecondaryLanguages Points to the buffer to hold the returned null-terminated
+ ASCII string that describes the list of
+ secondary languages for the specified
+ PrimaryLanguage. If there are no secondary
+ languages, the function returns successfully,
but this is set to NULL.
@param SecondaryLanguagesSize On entry, points to the size of the buffer
- pointed to by SecondLanguages, in bytes. On
- return, points to the length of SecondLanguages
+ pointed to by SecondaryLanguages, in bytes. On
+ return, points to the length of SecondaryLanguages
in bytes.
@retval EFI_SUCCESS Secondary languages were correctly returned.
- @retval EFI_INVALID_PARAMETER FirstLanguage or SecondLanguages or
- SecondLanguagesSize was NULL.
- @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondLanguagesSize is
+ @retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguages or
+ SecondaryLanguagesSize was NULL.
+ @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is
too small to hold the returned information.
- SecondLanguageSize is updated to hold the size of
+ SecondaryLanguageSize is updated to hold the size of
the buffer required.
- @retval EFI_INVALID_LANGUAGE The language specified by FirstLanguage is not
+ @retval EFI_INVALID_LANGUAGE The language specified by PrimaryLanguage is not
present in the specified package list.
@retval EFI_NOT_FOUND The specified PackageList is not in the Database.
@@ -1120,7 +1124,7 @@ EFIAPI HiiGetSecondaryLanguages (
IN CONST EFI_HII_STRING_PROTOCOL *This,
IN EFI_HII_HANDLE PackageList,
- IN CONST CHAR8 *FirstLanguage,
+ IN CONST CHAR8 *PrimaryLanguage,
IN OUT CHAR8 *SecondaryLanguages,
IN OUT UINTN *SecondaryLanguagesSize
);
|