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

6 files changed, 85 insertions, 79 deletions

diff --git a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.c b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.c
index 76d1ec7..a37f5c9 100644
--- a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.c
+++ b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.c
@@ -1,7 +1,7 @@
 /** @file

   Driver to implement English version of Unicode Collation Protocol.

 

-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -171,12 +171,11 @@ InitializeUnicodeCollationEng (
 

 

 /**

-  Performs a case-insensitive comparison of two Null-terminated Unicode 

-  strings.

+  Performs a case-insensitive comparison of two Null-terminated strings.

 

   @param  This Protocol instance pointer.

-  @param  Str1 A pointer to a Null-terminated Unicode string.

-  @param  Str2 A pointer to a Null-terminated Unicode string.

+  @param  Str1 A pointer to a Null-terminated string.

+  @param  Str2 A pointer to a Null-terminated string.

 

   @retval 0   Str1 is equivalent to Str2

   @retval > 0 Str1 is lexically greater than Str2

@@ -205,11 +204,11 @@ EngStriColl (
 

 

 /**

-  Converts all the Unicode characters in a Null-terminated Unicode string to 

-  lower case Unicode characters.

+  Converts all the characters in a Null-terminated string to 

+  lower case characters.

 

   @param  This   Protocol instance pointer.

-  @param  Str    A pointer to a Null-terminated Unicode string.

+  @param  Str    A pointer to a Null-terminated string.

 

 **/

 VOID

@@ -227,11 +226,11 @@ EngStrLwr (
 

 

 /**

-  Converts all the Unicode characters in a Null-terminated Unicode string to upper

-  case Unicode characters.

+  Converts all the characters in a Null-terminated string to upper

+  case characters.

 

   @param  This   Protocol instance pointer.

-  @param  Str    A pointer to a Null-terminated Unicode string.

+  @param  Str    A pointer to a Null-terminated string.

 

 **/

 VOID

@@ -248,12 +247,12 @@ EngStrUpr (
 }

 

 /**

-  Performs a case-insensitive comparison of a Null-terminated Unicode 

-  pattern string and a Null-terminated Unicode string.

+  Performs a case-insensitive comparison of a Null-terminated

+  pattern string and a Null-terminated string.

 

   @param  This    Protocol instance pointer.

-  @param  String  A pointer to a Null-terminated Unicode string.

-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.

+  @param  String  A pointer to a Null-terminated string.

+  @param  Pattern A pointer to a Null-terminated pattern string.

 

   @retval TRUE    Pattern was found in String.

   @retval FALSE   Pattern was not found in String.

@@ -385,15 +384,14 @@ EngMetaiMatch (
 

 

 /**

-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated 

-  Unicode string.

+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.

 

   @param  This    Protocol instance pointer.

   @param  FatSize The size of the string Fat in bytes.

   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file

-                  name using an OEM character set.

-  @param  String  A pointer to a Null-terminated Unicode string. The string must

-                  be preallocated to hold FatSize Unicode characters.

+                  name using an 8-bit OEM character set.

+  @param  String  A pointer to a Null-terminated string. The string must

+                  be preallocated to hold FatSize characters.

 

 **/

 VOID

@@ -420,12 +418,12 @@ EngFatToStr (
 

 

 /**

-  Converts a Null-terminated Unicode string to legal characters in a FAT 

+  Converts a Null-terminated string to legal characters in a FAT 

   filename using an OEM character set. 

 

   @param  This    Protocol instance pointer.

-  @param  String  A pointer to a Null-terminated Unicode string. The string must

-                  be preallocated to hold FatSize Unicode characters.

+  @param  String  A pointer to a Null-terminated string. The string must

+                  be preallocated to hold FatSize characters.

   @param  FatSize The size of the string Fat in bytes.

   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file

                   name using an OEM character set.

diff --git a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
index 3e1e1dc..ac6dfc4 100644
--- a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
+++ b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
@@ -1,7 +1,7 @@
 /** @file

   Head file for Unicode Collation Protocol (English)

 

-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -50,12 +50,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 // Prototypes

 //

 /**

-  Performs a case-insensitive comparison of two Null-terminated Unicode 

-  strings.

+  Performs a case-insensitive comparison of two Null-terminated strings.

 

   @param  This Protocol instance pointer.

-  @param  Str1 A pointer to a Null-terminated Unicode string.

-  @param  Str2 A pointer to a Null-terminated Unicode string.

+  @param  Str1 A pointer to a Null-terminated string.

+  @param  Str2 A pointer to a Null-terminated string.

 

   @retval 0   Str1 is equivalent to Str2

   @retval > 0 Str1 is lexically greater than Str2

@@ -71,12 +70,12 @@ EngStriColl (
   );

 

 /**

-  Performs a case-insensitive comparison of a Null-terminated Unicode 

-  pattern string and a Null-terminated Unicode string.

+  Performs a case-insensitive comparison of a Null-terminated

+  pattern string and a Null-terminated string.

 

   @param  This    Protocol instance pointer.

-  @param  String  A pointer to a Null-terminated Unicode string.

-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.

+  @param  String  A pointer to a Null-terminated string.

+  @param  Pattern A pointer to a Null-terminated pattern string.

 

   @retval TRUE    Pattern was found in String.

   @retval FALSE   Pattern was not found in String.

@@ -91,11 +90,11 @@ EngMetaiMatch (
   );

 

 /**

-  Converts all the Unicode characters in a Null-terminated Unicode string to 

-  lower case Unicode characters.

+  Converts all the characters in a Null-terminated string to 

+  lower case characters.

 

   @param  This   Protocol instance pointer.

-  @param  Str    A pointer to a Null-terminated Unicode string.

+  @param  Str    A pointer to a Null-terminated string.

 

 **/

 VOID

@@ -106,11 +105,11 @@ EngStrLwr (
   );

 

 /**

-  Converts all the Unicode characters in a Null-terminated Unicode string to upper

-  case Unicode characters.

+  Converts all the characters in a Null-terminated string to upper

+  case characters.

 

   @param  This   Protocol instance pointer.

-  @param  Str    A pointer to a Null-terminated Unicode string.

+  @param  Str    A pointer to a Null-terminated string.

 

 **/

 VOID

@@ -121,15 +120,14 @@ EngStrUpr (
   );

 

 /**

-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated 

-  Unicode string.

+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.

 

   @param  This    Protocol instance pointer.

   @param  FatSize The size of the string Fat in bytes.

   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file

-                  name using an OEM character set.

-  @param  String  A pointer to a Null-terminated Unicode string. The string must

-                  be preallocated to hold FatSize Unicode characters.

+                  name using an 8-bit OEM character set.

+  @param  String  A pointer to a Null-terminated string. The string must

+                  be preallocated to hold FatSize characters.

 

 **/

 VOID

@@ -142,12 +140,12 @@ EngFatToStr (
   );

 

 /**

-  Converts a Null-terminated Unicode string to legal characters in a FAT 

+  Converts a Null-terminated string to legal characters in a FAT 

   filename using an OEM character set. 

 

   @param  This    Protocol instance pointer.

-  @param  String  A pointer to a Null-terminated Unicode string. The string must

-                  be preallocated to hold FatSize Unicode characters.

+  @param  String  A pointer to a Null-terminated string. The string must

+                  be preallocated to hold FatSize characters.

   @param  FatSize The size of the string Fat in bytes.

   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file

                   name using an OEM character set.

diff --git a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
index d4f730a..1f6b888 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

   );

diff --git a/MdeModulePkg/Universal/HiiDatabaseDxe/String.c b/MdeModulePkg/Universal/HiiDatabaseDxe/String.c
index 92d0664..bec8ce7 100644
--- a/MdeModulePkg/Universal/HiiDatabaseDxe/String.c
+++ b/MdeModulePkg/Universal/HiiDatabaseDxe/String.c
@@ -1763,7 +1763,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.

@@ -1851,25 +1852,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

+  @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

-                                 FirstLanguage. If there are no secondary

-                                 languages, the function  returns successfully, but

+                                 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 SecondaryLanguages, in bytes. On return,

+                                 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 SecondaryLanguages or

+  @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

-                                  present in the specified package list.

+  @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.                                

 

 **/

@@ -1878,7 +1882,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

   )

@@ -1892,7 +1896,7 @@ HiiGetSecondaryLanguages (
   CHAR8                               *Languages;

   UINTN                               ResultSize;

 

-  if (This == NULL || PackageList == NULL || FirstLanguage == NULL) {

+  if (This == NULL || PackageList == NULL || PrimaryLanguage == NULL) {

     return EFI_INVALID_PARAMETER;

   }

   if (SecondaryLanguages == NULL || SecondaryLanguagesSize == NULL) {

@@ -1923,7 +1927,7 @@ HiiGetSecondaryLanguages (
          Link1 = Link1->ForwardLink

         ) {

     StringPackage = CR (Link1, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);

-    if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) FirstLanguage)) {

+    if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) PrimaryLanguage)) {

       Languages = StringPackage->StringPkgHdr->Language;

       //

       // Language is a series of ';' terminated strings, first one is primary

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
index 5867935..e753d9e 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
@@ -1,7 +1,7 @@
 /** @file

   Implementation for EFI iSCSI Initiator Name Protocol.

 

-Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -25,7 +25,8 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {
   @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.

   @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the

                               variable data buffer.

-  @param[out]      Buffer     Pointer to the buffer for data to be read.

+  @param[out]      Buffer     Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.

+                              The maximum length is 223 characters, including the null-terminator.

 

   @retval EFI_SUCCESS           Data was successfully retrieved into the provided buffer and the

                                 BufferSize was sufficient to handle the iSCSI initiator name.

@@ -64,7 +65,8 @@ IScsiGetInitiatorName (
 

   @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.

   @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer.

-  @param[in]       Buffer     Pointer to the buffer for data to be written.

+  @param[in]       Buffer     Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.

+                              The maximum length is 223 characters, including the null-terminator.

 

   @retval EFI_SUCCESS           Data was successfully stored by the protocol.

   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
index 5329e51..3c68235 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
@@ -1,7 +1,7 @@
 /** @file

   Interface routine for Mtftp4.

   

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -936,8 +936,8 @@ EfiMtftp4ReadDirectory (
                                  parameters. If NULL, the default parameters that 

                                  were set in the EFI_MTFTP4_PROTOCOL.Configure() 

                                  function are used

-  @param  Filename               Pointer to ASCIIZ file name string

-  @param  ModeStr                Pointer to ASCIIZ mode string. If NULL, "octet" 

+  @param  Filename               Pointer to null-terminated ASCII file name string

+  @param  ModeStr                Pointer to null-terminated ASCII mode string. If NULL, "octet" 

                                  will be used

   @param  OptionCount            Number of option/value string pairs in OptionList

   @param  OptionList             Pointer to array of option/value string pairs.