]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
MdeModulePkg: Removing ipf which is no longer supported from edk2.
[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UnicodeCollation / EnglishDxe / UnicodeCollationEng.h
index 3e1e1dca684ed53736e628c481884d794efb41a8..ddce2f69d375a68466e6353f4790187c7dc1d23e 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 - 2018, 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
-  filename using an OEM character set. \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
@@ -167,13 +165,13 @@ EngStrToFat (
 \r
 /**\r
   The user Entry Point for English module.\r
\r
+\r
   This function initializes unicode character mapping and then installs Unicode\r
-  Collation & Unicode Collation 2 Protocols based on the feature flags.  \r
+  Collation & Unicode Collation 2 Protocols based on the feature flags.\r
 \r
-  @param  ImageHandle    The firmware allocated handle for the EFI image.  \r
+  @param  ImageHandle    The firmware allocated handle for the EFI image.\r
   @param  SystemTable    A pointer to the EFI System Table.\r
-  \r
+\r
   @retval EFI_SUCCESS    The entry point is executed successfully.\r
   @retval other          Some error occurs when executing this entry point.\r
 \r