]> git.proxmox.com Git - mirror_edk2.git/commitdiff
String Reference Cleanup.
authorlzeng14 <lzeng14@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 8 Jun 2011 05:53:18 +0000 (05:53 +0000)
committerlzeng14 <lzeng14@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 8 Jun 2011 05:53:18 +0000 (05:53 +0000)
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

21 files changed:
EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiDatabase.c
EdkCompatibilityPkg/Compatibility/Uc2OnUcThunk/Uc2OnUcThunk.c
EdkCompatibilityPkg/Compatibility/UcOnUc2Thunk/UcOnUc2Thunk.c
MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.c
MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
MdeModulePkg/Universal/HiiDatabaseDxe/String.c
MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
MdePkg/Include/Protocol/DevicePath.h
MdePkg/Include/Protocol/FirmwareManagement.h
MdePkg/Include/Protocol/Ftp4.h
MdePkg/Include/Protocol/HiiString.h
MdePkg/Include/Protocol/IScsiInitiatorName.h
MdePkg/Include/Protocol/Ip6Config.h
MdePkg/Include/Protocol/IpSecConfig.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/Mtftp6.h
MdePkg/Include/Protocol/UnicodeCollation.h
NetworkPkg/Mtftp6Dxe/Mtftp6Impl.c
NetworkPkg/Mtftp6Dxe/Mtftp6Impl.h

index 854d0ec451cf8e4bef8d7e81276154f24d83ce01..5453c5a754cf4f4f3d43f4bc36e53d5deff6b1b1 100644 (file)
@@ -2,7 +2,7 @@
 Framework to UEFI 2.1 HII Thunk. The driver consume UEFI HII protocols\r
 to produce a Framework HII protocol.\r
 \r
-Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2008 - 2011, 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
@@ -386,7 +386,7 @@ Done:
   If not enough resource to complete the operation, then ASSERT.\r
 \r
   @param  HiiHandle              The HII package list handle.\r
-  @param  FirstLanguage          Pointer to language name buffer.\r
+  @param  PrimaryLanguage        Pointer to language name buffer.\r
   \r
   @return The supported languages.\r
 \r
@@ -395,7 +395,7 @@ CHAR8 *
 EFIAPI\r
 HiiGetSupportedSecondaryLanguages (\r
   IN EFI_HII_HANDLE           HiiHandle,\r
-  IN CONST CHAR8              *FirstLanguage\r
+  IN CONST CHAR8              *PrimaryLanguage\r
   )\r
 {\r
   EFI_STATUS  Status;\r
@@ -414,7 +414,7 @@ HiiGetSupportedSecondaryLanguages (
     return NULL;\r
   }\r
 \r
-  Status = mHiiStringProtocol->GetSecondaryLanguages (mHiiStringProtocol, HiiHandle, FirstLanguage, LanguageString, &BufferSize);\r
+  Status = mHiiStringProtocol->GetSecondaryLanguages (mHiiStringProtocol, HiiHandle, PrimaryLanguage, LanguageString, &BufferSize);\r
   ASSERT (Status != EFI_NOT_FOUND);\r
   \r
   if (Status == EFI_BUFFER_TOO_SMALL) {\r
@@ -424,7 +424,7 @@ HiiGetSupportedSecondaryLanguages (
       return NULL;\r
     }\r
 \r
-    Status = mHiiStringProtocol->GetSecondaryLanguages (mHiiStringProtocol, HiiHandle, FirstLanguage, LanguageString, &BufferSize);\r
+    Status = mHiiStringProtocol->GetSecondaryLanguages (mHiiStringProtocol, HiiHandle, PrimaryLanguage, LanguageString, &BufferSize);\r
   }\r
 \r
   if (EFI_ERROR (Status)) {\r
@@ -543,4 +543,3 @@ Done:
   return Status;\r
 }\r
 \r
\r
index 422d55aebc00331abb16b7b5108b11081e08a2ef..021f3e68f50b636c50df36bc951157b896690c54 100644 (file)
@@ -9,7 +9,7 @@ these two conditions are true:
 1) EFI 1.10 module producing UC present\r
 2) And the rest of modules on the platform consume UC2\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, 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
@@ -34,12 +34,11 @@ Module Name:
 #include <Library/LanguageLib.h>\r
 \r
 /**\r
-  Performs a case-insensitive comparison of two Null-terminated Unicode \r
-  strings.\r
+  Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
   @param  This Protocol instance pointer.\r
-  @param  Str1 A pointer to a Null-terminated Unicode string.\r
-  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+  @param  Str1 A pointer to a Null-terminated string.\r
+  @param  Str2 A pointer to a Null-terminated string.\r
 \r
   @retval 0   Str1 is equivalent to Str2\r
   @retval > 0 Str1 is lexically greater than Str2\r
@@ -55,11 +54,11 @@ StriColl (
   );\r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to \r
-  lower case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to \r
+  lower case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -70,11 +69,11 @@ StrLwr (
   );\r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
-  case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to upper\r
+  case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -85,12 +84,12 @@ StrUpr (
   );\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated Unicode \r
-  pattern string and a Null-terminated Unicode string.\r
+  Performs a case-insensitive comparison of a Null-terminated\r
+  pattern string and a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string.\r
-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+  @param  String  A pointer to a Null-terminated string.\r
+  @param  Pattern A pointer to a Null-terminated pattern string.\r
 \r
   @retval TRUE    Pattern was found in String.\r
   @retval FALSE   Pattern was not found in String.\r
@@ -105,15 +104,14 @@ MetaiMatch (
   );\r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
-  Unicode string.\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
 \r
 **/\r
 VOID\r
@@ -126,12 +124,12 @@ FatToStr (
   );\r
 \r
 /**\r
-  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  Converts a Null-terminated string to legal characters in a FAT \r
   filename using an OEM character set. \r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
@@ -301,12 +299,11 @@ InitializeUC2 (
 \r
 \r
 /**\r
-  Performs a case-insensitive comparison of two Null-terminated Unicode \r
-  strings.\r
+  Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
   @param  This Protocol instance pointer.\r
-  @param  Str1 A pointer to a Null-terminated Unicode string.\r
-  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+  @param  Str1 A pointer to a Null-terminated string.\r
+  @param  Str2 A pointer to a Null-terminated string.\r
 \r
   @retval 0   Str1 is equivalent to Str2\r
   @retval > 0 Str1 is lexically greater than Str2\r
@@ -330,11 +327,11 @@ StriColl (
 \r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to \r
-  lower case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to \r
+  lower case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -353,11 +350,11 @@ StrLwr (
 \r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
-  case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to upper\r
+  case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -375,12 +372,12 @@ StrUpr (
 }\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated Unicode \r
-  pattern string and a Null-terminated Unicode string.\r
+  Performs a case-insensitive comparison of a Null-terminated\r
+  pattern string and a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string.\r
-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+  @param  String  A pointer to a Null-terminated string.\r
+  @param  Pattern A pointer to a Null-terminated pattern string.\r
 \r
   @retval TRUE    Pattern was found in String.\r
   @retval FALSE   Pattern was not found in String.\r
@@ -403,15 +400,14 @@ MetaiMatch (
 \r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
-  Unicode string.\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
-                  name using an OEM character set.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+                  name using an 8-bit OEM character set.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
 \r
 **/\r
 VOID\r
@@ -432,12 +428,12 @@ FatToStr (
 \r
 \r
 /**\r
-  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  Converts a Null-terminated string to legal characters in a FAT \r
   filename using an OEM character set. \r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
index bb863137f9764d36d80486fcea5345fbffd38677..1a2c3914ef97569d862b5e15d487ac63b14895da 100644 (file)
@@ -9,7 +9,7 @@ these two conditions are true:
 1) EFI 1.10 module consuming UC present\r
 2) And the rest of modules on the platform produce UC2\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, 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
@@ -34,12 +34,11 @@ Module Name:
 #include <Library/LanguageLib.h>\r
 \r
 /**\r
-  Performs a case-insensitive comparison of two Null-terminated Unicode \r
-  strings.\r
+  Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
   @param  This Protocol instance pointer.\r
-  @param  Str1 A pointer to a Null-terminated Unicode string.\r
-  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+  @param  Str1 A pointer to a Null-terminated string.\r
+  @param  Str2 A pointer to a Null-terminated string.\r
 \r
   @retval 0   Str1 is equivalent to Str2\r
   @retval > 0 Str1 is lexically greater than Str2\r
@@ -55,11 +54,11 @@ StriColl (
   );\r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to \r
-  lower case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to \r
+  lower case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -70,11 +69,11 @@ StrLwr (
   );\r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
-  case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to upper\r
+  case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -85,12 +84,12 @@ StrUpr (
   );\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated Unicode \r
-  pattern string and a Null-terminated Unicode string.\r
+  Performs a case-insensitive comparison of a Null-terminated\r
+  pattern string and a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string.\r
-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+  @param  String  A pointer to a Null-terminated string.\r
+  @param  Pattern A pointer to a Null-terminated pattern string.\r
 \r
   @retval TRUE    Pattern was found in String.\r
   @retval FALSE   Pattern was not found in String.\r
@@ -105,15 +104,14 @@ MetaiMatch (
   );\r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
-  Unicode string.\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
 \r
 **/\r
 VOID\r
@@ -126,12 +124,12 @@ FatToStr (
   );\r
 \r
 /**\r
-  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  Converts a Null-terminated string to legal characters in a FAT \r
   filename using an OEM character set. \r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
@@ -302,12 +300,11 @@ InitializeUC (
 \r
 \r
 /**\r
-  Performs a case-insensitive comparison of two Null-terminated Unicode \r
-  strings.\r
+  Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
   @param  This Protocol instance pointer.\r
-  @param  Str1 A pointer to a Null-terminated Unicode string.\r
-  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+  @param  Str1 A pointer to a Null-terminated string.\r
+  @param  Str2 A pointer to a Null-terminated string.\r
 \r
   @retval 0   Str1 is equivalent to Str2\r
   @retval > 0 Str1 is lexically greater than Str2\r
@@ -331,11 +328,11 @@ StriColl (
 \r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to \r
-  lower case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to \r
+  lower case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -354,11 +351,11 @@ StrLwr (
 \r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
-  case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to upper\r
+  case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -376,12 +373,12 @@ StrUpr (
 }\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated Unicode \r
-  pattern string and a Null-terminated Unicode string.\r
+  Performs a case-insensitive comparison of a Null-terminated\r
+  pattern string and a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string.\r
-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+  @param  String  A pointer to a Null-terminated string.\r
+  @param  Pattern A pointer to a Null-terminated pattern string.\r
 \r
   @retval TRUE    Pattern was found in String.\r
   @retval FALSE   Pattern was not found in String.\r
@@ -404,15 +401,14 @@ MetaiMatch (
 \r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
-  Unicode string.\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
-                  name using an OEM character set.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+                  name using an 8-bit OEM character set.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
 \r
 **/\r
 VOID\r
@@ -433,12 +429,12 @@ FatToStr (
 \r
 \r
 /**\r
-  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  Converts a Null-terminated string to legal characters in a FAT \r
   filename using an OEM character set. \r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
index 76d1ec7729603c3e58dcd267db41fb10983e927c..a37f5c923cd76bd2f14605f0ce09bea9ff827bb6 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Driver to implement English version of Unicode Collation Protocol.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, 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
@@ -171,12 +171,11 @@ InitializeUnicodeCollationEng (
 \r
 \r
 /**\r
-  Performs a case-insensitive comparison of two Null-terminated Unicode \r
-  strings.\r
+  Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
   @param  This Protocol instance pointer.\r
-  @param  Str1 A pointer to a Null-terminated Unicode string.\r
-  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+  @param  Str1 A pointer to a Null-terminated string.\r
+  @param  Str2 A pointer to a Null-terminated string.\r
 \r
   @retval 0   Str1 is equivalent to Str2\r
   @retval > 0 Str1 is lexically greater than Str2\r
@@ -205,11 +204,11 @@ EngStriColl (
 \r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to \r
-  lower case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to \r
+  lower case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -227,11 +226,11 @@ EngStrLwr (
 \r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
-  case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to upper\r
+  case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -248,12 +247,12 @@ EngStrUpr (
 }\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated Unicode \r
-  pattern string and a Null-terminated Unicode string.\r
+  Performs a case-insensitive comparison of a Null-terminated\r
+  pattern string and a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string.\r
-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+  @param  String  A pointer to a Null-terminated string.\r
+  @param  Pattern A pointer to a Null-terminated pattern string.\r
 \r
   @retval TRUE    Pattern was found in String.\r
   @retval FALSE   Pattern was not found in String.\r
@@ -385,15 +384,14 @@ EngMetaiMatch (
 \r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
-  Unicode string.\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
-                  name using an OEM character set.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+                  name using an 8-bit OEM character set.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
 \r
 **/\r
 VOID\r
@@ -420,12 +418,12 @@ EngFatToStr (
 \r
 \r
 /**\r
-  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  Converts a Null-terminated string to legal characters in a FAT \r
   filename using an OEM character set. \r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
index 3e1e1dca684ed53736e628c481884d794efb41a8..ac6dfc4033883dabb363250ae0318d394938b0e9 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Head file for Unicode Collation Protocol (English)\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, 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
@@ -50,12 +50,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 // Prototypes\r
 //\r
 /**\r
-  Performs a case-insensitive comparison of two Null-terminated Unicode \r
-  strings.\r
+  Performs a case-insensitive comparison of two Null-terminated strings.\r
 \r
   @param  This Protocol instance pointer.\r
-  @param  Str1 A pointer to a Null-terminated Unicode string.\r
-  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+  @param  Str1 A pointer to a Null-terminated string.\r
+  @param  Str2 A pointer to a Null-terminated string.\r
 \r
   @retval 0   Str1 is equivalent to Str2\r
   @retval > 0 Str1 is lexically greater than Str2\r
@@ -71,12 +70,12 @@ EngStriColl (
   );\r
 \r
 /**\r
-  Performs a case-insensitive comparison of a Null-terminated Unicode \r
-  pattern string and a Null-terminated Unicode string.\r
+  Performs a case-insensitive comparison of a Null-terminated\r
+  pattern string and a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string.\r
-  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+  @param  String  A pointer to a Null-terminated string.\r
+  @param  Pattern A pointer to a Null-terminated pattern string.\r
 \r
   @retval TRUE    Pattern was found in String.\r
   @retval FALSE   Pattern was not found in String.\r
@@ -91,11 +90,11 @@ EngMetaiMatch (
   );\r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to \r
-  lower case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to \r
+  lower case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -106,11 +105,11 @@ EngStrLwr (
   );\r
 \r
 /**\r
-  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
-  case Unicode characters.\r
+  Converts all the characters in a Null-terminated string to upper\r
+  case characters.\r
 \r
   @param  This   Protocol instance pointer.\r
-  @param  Str    A pointer to a Null-terminated Unicode string.\r
+  @param  Str    A pointer to a Null-terminated string.\r
 \r
 **/\r
 VOID\r
@@ -121,15 +120,14 @@ EngStrUpr (
   );\r
 \r
 /**\r
-  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
-  Unicode string.\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.\r
 \r
   @param  This    Protocol instance pointer.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
-                  name using an OEM character set.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+                  name using an 8-bit OEM character set.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
 \r
 **/\r
 VOID\r
@@ -142,12 +140,12 @@ EngFatToStr (
   );\r
 \r
 /**\r
-  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  Converts a Null-terminated string to legal characters in a FAT \r
   filename using an OEM character set. \r
 \r
   @param  This    Protocol instance pointer.\r
-  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
-                  be preallocated to hold FatSize Unicode characters.\r
+  @param  String  A pointer to a Null-terminated string. The string must\r
+                  be preallocated to hold FatSize characters.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
                   name using an OEM character set.\r
index d4f730abb8382fbb17c1500a4f634c39d4c5c2c4..1f6b888ec51a6135d6e816a08b76e996d1255e55 100644 (file)
@@ -1060,7 +1060,8 @@ HiiSetString (
   @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                   instance.\r
   @param  PackageList             The package list to examine.\r
-  @param  Languages               Points to the buffer to hold the returned string.\r
+  @param  Languages               Points to the buffer to hold the returned\r
+                                  null-terminated ASCII string.\r
   @param  LanguagesSize           On entry, points to the size of the buffer\r
                                   pointed to by  Languages, in bytes. On  return,\r
                                   points to the length of Languages, in bytes.\r
@@ -1092,25 +1093,28 @@ HiiGetLanguages (
   @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                   instance.\r
   @param  PackageList             The package list to examine.\r
-  @param  FirstLanguage           Points to the primary language.\r
-  @param  SecondaryLanguages      Points to the buffer to hold the returned list of\r
-                                   secondary languages for the specified\r
-                                  FirstLanguage. If there are no secondary\r
-                                  languages, the function  returns successfully,\r
+  @param  PrimaryLanguage         Points to the null-terminated ASCII string that specifies\r
+                                  the primary language. Languages are specified in the\r
+                                  format specified in Appendix M of the UEFI 2.0 specification.\r
+  @param  SecondaryLanguages      Points to the buffer to hold the returned null-terminated\r
+                                  ASCII string that describes the list of\r
+                                  secondary languages for the specified\r
+                                  PrimaryLanguage. If there are no secondary\r
+                                  languages, the function returns successfully,\r
                                   but this is set to NULL.\r
   @param  SecondaryLanguagesSize  On entry, points to the size of the buffer\r
-                                  pointed to  by SecondLanguages, in bytes. On\r
-                                  return, points to the length of SecondLanguages\r
+                                  pointed to by SecondaryLanguages, in bytes. On\r
+                                  return, points to the length of SecondaryLanguages\r
                                   in bytes.\r
 \r
   @retval EFI_SUCCESS             Secondary languages were correctly returned.\r
-  @retval EFI_INVALID_PARAMETER   FirstLanguage or SecondLanguages or\r
-                                  SecondLanguagesSize was NULL.\r
-  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by SecondLanguagesSize is\r
+  @retval EFI_INVALID_PARAMETER   PrimaryLanguage or SecondaryLanguages or\r
+                                  SecondaryLanguagesSize was NULL.\r
+  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by SecondaryLanguagesSize is\r
                                   too small to hold the returned information.\r
-                                  SecondLanguageSize is updated to hold the size of\r
+                                  SecondaryLanguageSize is updated to hold the size of\r
                                   the buffer required.\r
-  @retval EFI_INVALID_LANGUAGE           The language specified by FirstLanguage is not\r
+  @retval EFI_INVALID_LANGUAGE    The language specified by PrimaryLanguage is not\r
                                   present in the specified package list.\r
   @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.                                \r
 \r
@@ -1120,7 +1124,7 @@ EFIAPI
 HiiGetSecondaryLanguages (\r
   IN CONST EFI_HII_STRING_PROTOCOL   *This,\r
   IN EFI_HII_HANDLE                  PackageList,\r
-  IN CONST CHAR8                     *FirstLanguage,\r
+  IN CONST CHAR8                     *PrimaryLanguage,\r
   IN OUT CHAR8                       *SecondaryLanguages,\r
   IN OUT UINTN                       *SecondaryLanguagesSize\r
   );\r
index 92d066485620ecea3663872e0a22a41af15864db..bec8ce748c7aa265431d761477b1b960483bfe4e 100644 (file)
@@ -1763,7 +1763,8 @@ HiiSetString (
 \r
   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
   @param  PackageList            The package list to examine.\r
-  @param  Languages              Points to the buffer to hold the returned string.\r
+  @param  Languages              Points to the buffer to hold the returned\r
+                                 null-terminated ASCII string.\r
   @param  LanguagesSize          On entry, points to the size of the buffer pointed\r
                                  to by  Languages, in bytes. On  return, points to\r
                                  the length of Languages, in bytes.\r
@@ -1851,25 +1852,28 @@ HiiGetLanguages (
 \r
   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
   @param  PackageList            The package list to examine.\r
-  @param  FirstLanguage          Points to the primary language.\r
-  @param  SecondaryLanguages     Points to the buffer to hold the returned list of\r
+  @param  PrimaryLanguage        Points to the null-terminated ASCII string that specifies\r
+                                 the primary language. Languages are specified in the\r
+                                 format specified in Appendix M of the UEFI 2.0 specification.\r
+  @param  SecondaryLanguages     Points to the buffer to hold the returned null-terminated\r
+                                 ASCII string that describes the list of\r
                                  secondary languages for the specified\r
-                                 FirstLanguage. If there are no secondary\r
-                                 languages, the function  returns successfully, but\r
+                                 PrimaryLanguage. If there are no secondary\r
+                                 languages, the function returns successfully, but\r
                                  this is set to NULL.\r
   @param  SecondaryLanguagesSize On entry, points to the size of the buffer pointed\r
-                                 to  by SecondaryLanguages, in bytes. On return,\r
+                                 to by SecondaryLanguages, in bytes. On return,\r
                                  points to the length of SecondaryLanguages in bytes.\r
 \r
   @retval EFI_SUCCESS            Secondary languages were correctly returned.\r
-  @retval EFI_INVALID_PARAMETER  FirstLanguage or SecondaryLanguages or\r
+  @retval EFI_INVALID_PARAMETER  PrimaryLanguage or SecondaryLanguages or\r
                                  SecondaryLanguagesSize was NULL.\r
   @retval EFI_BUFFER_TOO_SMALL   The buffer specified by SecondaryLanguagesSize is\r
                                  too small to hold the returned information.\r
-                                 SecondLanguageSize is updated to hold the size of\r
+                                 SecondaryLanguageSize is updated to hold the size of\r
                                  the buffer required.\r
-  @retval EFI_INVALID_LANGUAGE           The language specified by FirstLanguage is not\r
-                                  present in the specified package list.\r
+  @retval EFI_INVALID_LANGUAGE   The language specified by PrimaryLanguage is not\r
+                                 present in the specified package list.\r
   @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.                                \r
 \r
 **/\r
@@ -1878,7 +1882,7 @@ EFIAPI
 HiiGetSecondaryLanguages (\r
   IN CONST EFI_HII_STRING_PROTOCOL   *This,\r
   IN EFI_HII_HANDLE                  PackageList,\r
-  IN CONST CHAR8                     *FirstLanguage,\r
+  IN CONST CHAR8                     *PrimaryLanguage,\r
   IN OUT CHAR8                       *SecondaryLanguages,\r
   IN OUT UINTN                       *SecondaryLanguagesSize\r
   )\r
@@ -1892,7 +1896,7 @@ HiiGetSecondaryLanguages (
   CHAR8                               *Languages;\r
   UINTN                               ResultSize;\r
 \r
-  if (This == NULL || PackageList == NULL || FirstLanguage == NULL) {\r
+  if (This == NULL || PackageList == NULL || PrimaryLanguage == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
   if (SecondaryLanguages == NULL || SecondaryLanguagesSize == NULL) {\r
@@ -1923,7 +1927,7 @@ HiiGetSecondaryLanguages (
          Link1 = Link1->ForwardLink\r
         ) {\r
     StringPackage = CR (Link1, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
-    if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) FirstLanguage)) {\r
+    if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) PrimaryLanguage)) {\r
       Languages = StringPackage->StringPkgHdr->Language;\r
       //\r
       // Language is a series of ';' terminated strings, first one is primary\r
index 5867935fa49a950350137b0985f1d92c858efcfb..e753d9eebdbe3320d5e1e38062b13d0df49b1b58 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Implementation for EFI iSCSI Initiator Name Protocol.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2011, 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
@@ -25,7 +25,8 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {
   @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
   @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the\r
                               variable data buffer.\r
-  @param[out]      Buffer     Pointer to the buffer for data to be read.\r
+  @param[out]      Buffer     Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.\r
+                              The maximum length is 223 characters, including the null-terminator.\r
 \r
   @retval EFI_SUCCESS           Data was successfully retrieved into the provided buffer and the\r
                                 BufferSize was sufficient to handle the iSCSI initiator name.\r
@@ -64,7 +65,8 @@ IScsiGetInitiatorName (
 \r
   @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
   @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer.\r
-  @param[in]       Buffer     Pointer to the buffer for data to be written.\r
+  @param[in]       Buffer     Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.\r
+                              The maximum length is 223 characters, including the null-terminator.\r
 \r
   @retval EFI_SUCCESS           Data was successfully stored by the protocol.\r
   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.\r
index 5329e51863c335586af0a3d42cb802f9df28a95b..3c68235d4236fc76c6de28f37f0f59850f44c3b3 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Interface routine for Mtftp4.\r
   \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, 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
@@ -936,8 +936,8 @@ EfiMtftp4ReadDirectory (
                                  parameters. If NULL, the default parameters that \r
                                  were set in the EFI_MTFTP4_PROTOCOL.Configure() \r
                                  function are used\r
-  @param  Filename               Pointer to ASCIIZ file name string\r
-  @param  ModeStr                Pointer to ASCIIZ mode string. If NULL, "octet" \r
+  @param  Filename               Pointer to null-terminated ASCII file name string\r
+  @param  ModeStr                Pointer to null-terminated ASCII mode string. If NULL, "octet" \r
                                  will be used\r
   @param  OptionCount            Number of option/value string pairs in OptionList\r
   @param  OptionList             Pointer to array of option/value string pairs. \r
index 47518961f886517dcafb2ea38cfcdeb534525724..7a65f5e33a5e2837d1ab50109490cea3d7773908 100644 (file)
@@ -965,7 +965,7 @@ typedef struct {
   ///\r
   UINT16                          StatusFlag;\r
   ///\r
-  /// ASCIIZ string that describes the boot device to a user. \r
+  /// Null-terminated ASCII string that describes the boot device to a user.\r
   ///\r
   CHAR8                           String[1];\r
 } BBS_BBS_DEVICE_PATH;\r
index 18f18fb4baf2c423c19fa7a84726b3086f5e3fb2..617b96ab13581bf73d2d8493d2f2a00faa7b62c4 100644 (file)
@@ -8,7 +8,7 @@
   CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return \r
   EFI_UNSUPPORTED if not supported by the driver.\r
   \r
-  Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, 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
@@ -51,7 +51,7 @@ typedef struct {
   /// \r
   UINT64                           ImageId;\r
   /// \r
-  /// A pointer to a null-terminated Unicode string representing the firmware image name.  \r
+  /// A pointer to a null-terminated string representing the firmware image name.  \r
   /// \r
   CHAR16                           *ImageIdName;\r
   /// \r
@@ -60,7 +60,7 @@ typedef struct {
   /// \r
   UINT32                           Version;\r
   /// \r
-  /// A pointer to a null-terminated Unicode string representing the firmware image version name.\r
+  /// A pointer to a null-terminated string representing the firmware image version name.\r
   /// \r
   CHAR16                           *VersionName;\r
   /// \r
@@ -239,7 +239,7 @@ EFI_STATUS
                                      0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version comparison\r
                                      is to be performed using PackageVersionName. A value of 0xFFFFFFFD indicates\r
                                      that package version update is in progress.\r
-  @param[out]     PackageVersionName A pointer to a pointer to a null-terminated Unicode string representing the\r
+  @param[out]     PackageVersionName A pointer to a pointer to a null-terminated string representing the\r
                                      package version name. The buffer is allocated by this function with \r
                                      AllocatePool(), and it is the caller's responsibility to free it with a call\r
                                      to FreePool().\r
@@ -330,7 +330,7 @@ EFI_STATUS
   @param[in]  VendorCode         This enables vendor to implement vendor-specific firmware image update policy.  \r
                                  Null indicates the caller did not specify the policy or use the default policy.\r
   @param[in]  Progress           A function used by the driver to report the progress of the firmware update.\r
-  @param[out] AbortReason        A pointer to a pointer to a null-terminated Unicode string providing more\r
+  @param[out] AbortReason        A pointer to a pointer to a null-terminated string providing more\r
                                  details for the aborted operation. The buffer is allocated by this function \r
                                  with AllocatePool(), and it is the caller's responsibility to free it with a\r
                                  call to FreePool().\r
@@ -396,7 +396,7 @@ EFI_STATUS
                                        0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version\r
                                        comparison is to be performed using PackageVersionName. A value of\r
                                        0xFFFFFFFD indicates that package version update is in progress.\r
-  @param[out] PackageVersionName       A pointer to a pointer to a null-terminated Unicode string representing\r
+  @param[out] PackageVersionName       A pointer to a pointer to a null-terminated string representing\r
                                        the package version name. The buffer is allocated by this function with\r
                                        AllocatePool(), and it is the caller's responsibility to free it with a\r
                                        call to FreePool().\r
index ae437a8e992d4e522215aecdcf0734a3e75f03c5..1c4a5db92587327c09971987cda925a56e9ead23 100644 (file)
@@ -7,7 +7,7 @@
   The definitions in this file are defined in UEFI Specification 2.3, which have\r
   not been verified by one implementation yet.\r
 \r
-  Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, 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
@@ -180,7 +180,7 @@ struct _EFI_FTP4_COMMAND_TOKEN {
   /// \r
   EFI_EVENT                             Event; \r
   /// \r
-  /// Pointer to an ASCIIZ path name string. \r
+  /// Pointer to a null-terminated ASCII name string. \r
   /// \r
   UINT8                                 *Pathname;\r
   /// \r
index 3deeac033a1bbd1976e6839c9b41602b4bf33ebb..496ffa659e76b0af54d1a43cf89e2d1bb563386e 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   The file provides services to manipulate string data.\r
   \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -150,9 +150,10 @@ EFI_STATUS
 \r
   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
   @param  PackageList            The package list to examine.\r
-  @param  Languages              Points to the buffer to hold the returned string.\r
+  @param  Languages              Points to the buffer to hold the returned\r
+                                 null-terminated ASCII string.\r
   @param  LanguagesSize          On entry, points to the size of the buffer pointed\r
-                                 to by  Languages, in bytes. On  return, points to\r
+                                 to by Languages, in bytes. On return, points to\r
                                  the length of Languages, in bytes.\r
 \r
   @retval EFI_SUCCESS            The languages were returned successfully.\r
@@ -181,24 +182,27 @@ EFI_STATUS
 \r
   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
   @param  PackageList            The package list to examine.\r
-  @param  FirstLanguage          Points to the primary language.\r
-  @param  SecondaryLanguages     Points to the buffer to hold the returned list of\r
+  @param  PrimaryLanguage        Points to the null-terminated ASCII string that specifies\r
+                                 the primary language. Languages are specified in the\r
+                                 format specified in Appendix M of the UEFI 2.0 specification.\r
+  @param  SecondaryLanguages     Points to the buffer to hold the returned null-terminated\r
+                                 ASCII string that describes the list of\r
                                  secondary languages for the specified\r
-                                 FirstLanguage. If there are no secondary\r
-                                 languages, the function  returns successfully, but\r
+                                 PrimaryLanguage. If there are no secondary\r
+                                 languages, the function returns successfully, but\r
                                  this is set to NULL.\r
   @param  SecondaryLanguagesSize On entry, points to the size of the buffer pointed\r
-                                 to  by SecondaryLanguages, in bytes. On return,\r
+                                 to by SecondaryLanguages, in bytes. On return,\r
                                  points to the length of SecondaryLanguages in bytes.\r
 \r
   @retval EFI_SUCCESS            Secondary languages were correctly returned.\r
-  @retval EFI_INVALID_PARAMETER  FirstLanguage or SecondaryLanguages or\r
+  @retval EFI_INVALID_PARAMETER  PrimaryLanguage or SecondaryLanguages or\r
                                  SecondaryLanguagesSize was NULL.\r
   @retval EFI_BUFFER_TOO_SMALL   The buffer specified by SecondaryLanguagesSize is\r
                                  too small to hold the returned information.\r
-                                 SecondLanguageSize is updated to hold the size of\r
+                                 SecondaryLanguageSize is updated to hold the size of\r
                                  the buffer required.\r
-  @retval EFI_INVALID_LANGUAGE   The language specified by FirstLanguage is not\r
+  @retval EFI_INVALID_LANGUAGE   The language specified by PrimaryLanguage is not\r
                                  present in the specified package list.\r
   @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.                                \r
 \r
@@ -208,9 +212,9 @@ EFI_STATUS
 (EFIAPI *EFI_HII_GET_2ND_LANGUAGES)(\r
   IN CONST  EFI_HII_STRING_PROTOCOL   *This,\r
   IN        EFI_HII_HANDLE            PackageList,\r
-  IN CONST  CHAR8                     *FirstLanguage,\r
-  IN OUT    CHAR8                     *SecondLanguages,\r
-  IN OUT    UINTN                     *SecondLanguagesSize\r
+  IN CONST  CHAR8                     *PrimaryLanguage,\r
+  IN OUT    CHAR8                     *SecondaryLanguages,\r
+  IN OUT    UINTN                     *SecondaryLanguagesSize\r
 );\r
 \r
 \r
@@ -230,4 +234,3 @@ extern EFI_GUID gEfiHiiStringProtocolGuid;
 \r
 #endif\r
 \r
-\r
index f7b890e2a6ca4a2a54c05b432b72d278f250e6e2..e55c51b7c62ea336741bba6040058a633d418cde 100644 (file)
@@ -2,7 +2,7 @@
   EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.\r
   It provides the ability to get and set the iSCSI Initiator Name.                                                  \r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2011, 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
@@ -29,7 +29,8 @@ typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTO
   @param  This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
   @param  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the\r
                      variable data buffer.\r
-  @param  Buffer     Pointer to the buffer for data to be read.\r
+  @param  Buffer     Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.\r
+                     The maximum length is 223 characters, including the null-terminator.\r
 \r
   @retval EFI_SUCCESS           Data was successfully retrieved into the provided buffer and the\r
                                 BufferSize was sufficient to handle the iSCSI initiator name\r
@@ -53,7 +54,8 @@ EFI_STATUS
 \r
   @param  This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
   @param  BufferSize Size of the buffer in bytes pointed to by Buffer.\r
-  @param  Buffer     Pointer to the buffer for data to be written.\r
+  @param  Buffer     Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.\r
+                     The maximum length is 223 characters, including the null-terminator.\r
 \r
   @retval EFI_SUCCESS           Data was successfully stored by the protocol.\r
   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.\r
@@ -83,9 +85,3 @@ extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;
 \r
 #endif\r
 \r
-\r
-\r
-\r
-\r
-\r
-\r
index 7195ef6e578e2f784d99589a85fc77971fe832f3..b2c3be9ee7cf54e86757607642a23735d5ae46a4 100644 (file)
@@ -2,7 +2,7 @@
   This file provides a definition of the EFI IPv6 Configuration\r
   Protocol.\r
 \r
-Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2008 - 2011, 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<BR>\r
@@ -100,7 +100,7 @@ typedef enum {
 ///\r
 typedef struct {\r
   ///\r
-  /// The name of the interface. It is a NULL-terminated Unicode string.\r
+  /// The name of the interface. It is a NULL-terminated string.\r
   ///\r
   CHAR16                Name[32];\r
   /// \r
index e305381f7ecfa3b5a5da5249bbfecfec73b6662c..c6e2b36beba0bc905e413d9da87d3c4504f5ed94 100644 (file)
@@ -3,7 +3,7 @@
   The EFI_IPSEC_CONFIG_PROTOCOL provides the mechanism to set and retrieve security and \r
   policy related information for the EFI IPsec protocol driver.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, 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
@@ -331,7 +331,7 @@ typedef struct _EFI_IPSEC_SA_ID {
 ///\r
 typedef struct _EFI_IPSEC_SPD_DATA {\r
   /// \r
-  /// A null-terminated name string which is used as a symbolic \r
+  /// A null-terminated ASCII name string which is used as a symbolic \r
   /// identifier for an IPsec Local or Remote address.\r
   /// \r
   UINT8                           Name[MAX_PEERID_LEN];\r
@@ -522,7 +522,7 @@ typedef struct _EFI_IPSEC_PAD_ID {
     ///\r
     EFI_IP_ADDRESS_INFO   IpAddress;\r
     ///\r
-    /// Pointer to a null terminated string (8-bit ASCII character) \r
+    /// Pointer to a null terminated ASCII string\r
     /// representing the symbolic names. A PeerId can be a DNS \r
     /// name, Distinguished Name, RFC 822 email address or Key ID \r
     /// (specified in section 4.4.3.1 of RFC 4301)\r
index 031ef184eb62f6473494de35460a0a2cc47eeb17..1afac6cff5286024fb8f2922eb3f2740f0c1eb17 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   EFI Multicast Trivial File Tranfer Protocol Definition\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -313,8 +313,8 @@ EFI_STATUS
   @param  OverrideData Data that is used to override the existing parameters. If NULL,\r
                        the default parameters that were set in the\r
                        EFI_MTFTP4_PROTOCOL.Configure() function are used.\r
-  @param  Filename     The pointer to ASCIIZ file name string.\r
-  @param  ModeStr      The pointer to ASCIIZ mode string. If NULL, "octet" will be used.\r
+  @param  Filename     The pointer to null-terminated ASCII file name string.\r
+  @param  ModeStr      The pointer to null-terminated ASCII mode string. If NULL, "octet" will be used.\r
   @param  OptionCount  Number of option/value string pairs in OptionList.\r
   @param  OptionList   The pointer to array of option/value string pairs. Ignored if\r
                        OptionCount is zero.\r
@@ -542,11 +542,11 @@ struct _EFI_MTFTP4_TOKEN {
   ///\r
   EFI_MTFTP4_OVERRIDE_DATA    *OverrideData;\r
   ///\r
-  /// The pointer to the ASCIIZ file name string.\r
+  /// The pointer to the null-terminated ASCII file name string.\r
   ///\r
   UINT8                       *Filename;\r
   ///\r
-  /// The pointer to the ASCIIZ mode string. If NULL, "octet" is used.\r
+  /// The pointer to the null-terminated ASCII mode string. If NULL, "octet" is used.\r
   ///\r
   UINT8                       *ModeStr;\r
   ///\r
index b06a6719d535cd4655ae24bdec6144f146ab32b5..b9836607ec069e1fea3e7f1dd3d4b97d4b7a663a 100644 (file)
@@ -3,7 +3,7 @@
   the EFI UDPv6 Protocol and provides basic services for client-side unicast and/or\r
   multicast TFTP operations.\r
 \r
-  Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2008 - 2011, 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
@@ -265,7 +265,7 @@ typedef struct {
   ///\r
   UINT8                   SupportedOptionCount;\r
   ///\r
-  /// An array of option strings that are recognized and supported by\r
+  /// An array of null-terminated ASCII option strings that are recognized and supported by\r
   /// this EFI MTFTPv6 Protocol driver implementation. The buffer is\r
   /// read only to the caller and the caller should NOT free the buffer.\r
   ///\r
@@ -304,8 +304,8 @@ typedef struct {
 /// EFI_MTFTP6_OPTION\r
 ///\r
 typedef struct {\r
-  UINT8                  *OptionStr; ///< Pointer to the ASCIIZ MTFTPv6 option string.\r
-  UINT8                  *ValueStr;  ///< Pointer to the ASCIIZ MTFTPv6 value string.\r
+  UINT8                  *OptionStr; ///< Pointer to the null-terminated ASCII MTFTPv6 option string.\r
+  UINT8                  *ValueStr;  ///< Pointer to the null-terminated ASCII MTFTPv6 value string.\r
 } EFI_MTFTP6_OPTION;\r
 \r
 /**\r
@@ -409,11 +409,11 @@ struct _EFI_MTFTP6_TOKEN {
   ///\r
   EFI_MTFTP6_OVERRIDE_DATA    *OverrideData;\r
   ///\r
-  /// Pointer to the ASCIIZ file name string.\r
+  /// Pointer to the null-terminated ASCII file name string.\r
   ///\r
   UINT8                       *Filename;\r
   ///\r
-  /// Pointer to the ASCIIZ mode string. If NULL, octet is used.\r
+  /// Pointer to the null-terminated ASCII mode string. If NULL, octet is used.\r
   ///\r
   UINT8                       *ModeStr;\r
   ///\r
@@ -534,8 +534,8 @@ EFI_STATUS
   @param[in]  OverrideData       Data that is used to override the existing parameters. If NULL, the\r
                                  default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()\r
                                  function are used.\r
-  @param[in]  Filename           Pointer to ASCIIZ file name string.\r
-  @param[in]  ModeStr            Pointer to ASCIIZ mode string. If NULL, octet will be used\r
+  @param[in]  Filename           Pointer to null-terminated ASCII file name string.\r
+  @param[in]  ModeStr            Pointer to null-terminated ASCII mode string. If NULL, octet will be used\r
   @param[in]  OptionCount        Number of option/value string pairs in OptionList.\r
   @param[in]  OptionList         Pointer to array of option/value string pairs. Ignored if\r
                                  OptionCount is zero.\r
index 1a79af6a39dc80e7cf1c8803e41c77fb72cbc4da..f45c9ead0eaac0cbe75e0f2ab21d69bed2398daf 100644 (file)
@@ -3,7 +3,7 @@
   This protocol is used to allow code running in the boot services environment \r
   to perform lexical comparison functions on Unicode strings for given languages.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -125,7 +125,7 @@ VOID
   @param  This    A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
   @param  FatSize The size of the string Fat in bytes.\r
   @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
-                  name using an OEM character set.\r
+                  name using an 8-bit OEM character set.\r
   @param  String  A pointer to a Null-terminated string. The string must\r
                   be allocated in advance to hold FatSize characters.\r
 \r
index fcbbf111343db39e87e72fe33a42140e3eb7902e..79ae6e0741d0b88397be395d9fff28602cb97f0e 100644 (file)
@@ -8,7 +8,7 @@
    RFC2348 - TFTP Blocksize Option\r
    RFC2349 - TFTP Timeout Interval and Transfer Size Options\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -266,8 +266,8 @@ ON_EXIT:
   @param[in]  OverrideData       Data that is used to override the existing parameters. If NULL, the\r
                                  default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()\r
                                  function are used.\r
-  @param[in]  Filename           Pointer to ASCIIZ file name string.\r
-  @param[in]  ModeStr            Pointer to ASCIIZ mode string. If NULL, octet will be used.\r
+  @param[in]  Filename           Pointer to null-terminated ASCII file name string.\r
+  @param[in]  ModeStr            Pointer to null-terminated ASCII mode string. If NULL, octet will be used.\r
   @param[in]  OptionCount        Number of option/value string pairs in OptionList.\r
   @param[in]  OptionList         Pointer to array of option/value string pairs. Ignored if\r
                                  OptionCount is zero.\r
index bf924a980c477756a5162e8406ff32af42f4f032..626aea0e34342886be0ac5ab307a5cd23b9aeeaa 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Mtftp6 internal data structure and definition declaration.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>\r
+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved. <BR>\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -200,8 +200,8 @@ EfiMtftp6Configure (
   @param[in]  OverrideData       Data that is used to override the existing parameters. If NULL, the\r
                                  default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()\r
                                  function are used.\r
-  @param[in]  Filename           Pointer to ASCIIZ file name string.\r
-  @param[in]  ModeStr            Pointer to ASCIIZ mode string. If NULL, octet will be used\r
+  @param[in]  Filename           Pointer to null-terminated ASCII file name string.\r
+  @param[in]  ModeStr            Pointer to null-terminated ASCII mode string. If NULL, octet will be used\r
   @param[in]  OptionCount        Number of option/value string pairs in OptionList.\r
   @param[in]  OptionList         Pointer to array of option/value string pairs. Ignored if\r
                                  OptionCount is zero.\r