// Protocol member functions\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 This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\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
- @retval <_0 Str1 is lexically less than Str2\r
+ @retval >0 Str1 is lexically greater than Str2\r
+ @retval <0 Str1 is lexically less than Str2\r
\r
**/\r
typedef\r
);\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 This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\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
);\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 String A pointer to a Null-terminated Unicode string.\r
+ @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
+ @param String A pointer to a Null-terminated string.\r
\r
**/\r
typedef\r
);\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 String A pointer to a Null-terminated Unicode string.\r
+ @param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
+ @param String A pointer to a Null-terminated string.\r
\r
**/\r
typedef\r
\r
/**\r
Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
- Unicode string.\r
+ string.\r
\r
- @param This Protocol instance pointer.\r
+ @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
- @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 allocated in advance to hold FatSize characters.\r
\r
**/\r
typedef\r
);\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 This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.\r
+ @param String A pointer to a Null-terminated string.\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 Fat A pointer to a string that contains the converted version of \r
+ String using legal FAT characters from an OEM character set.\r
\r
- @retval TRUE Fat is a Long File Name\r
- @retval FALSE Fat is an 8.3 file name\r
+ @retval TRUE One or more conversions failed and were substituted with '_'\r
+ @retval FALSE None of the conversions failed.\r
\r
**/\r
typedef\r
OUT CHAR8 *Fat\r
);\r
\r
-/** \r
- @par Protocol Description:\r
- The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive \r
- comparisons of Unicode strings. \r
-\r
- @param StriColl\r
- Performs a case-insensitive comparison of two Null-terminated Unicode strings. \r
-\r
- @param MetaiMatch\r
- Performs a case-insensitive comparison between a Null-terminated Unicode \r
- pattern string and a Null-terminated Unicode string. The pattern string \r
- can use the '?' wildcard to match any character, and the '*' wildcard to \r
- match any substring. \r
-\r
- @param StrLwr\r
- Converts all the Unicode characters in a Null-terminated Unicode string to \r
- lowercase Unicode characters. \r
-\r
- @param StrUpr\r
- Converts all the Unicode characters in a Null-terminated Unicode string to \r
- uppercase Unicode characters. \r
-\r
- @param FatToStr\r
- Converts an 8.3 FAT file name using an OEM character set to a Null-terminated \r
- Unicode string. \r
-\r
- @param StrToFat\r
- Converts a Null-terminated Unicode string to legal characters in a FAT \r
- filename using an OEM character set. \r
-\r
- @param Supported\r
- LanguagesA Null-terminated ASCII string array that contains one or more \r
- language codes. This array is specified in RFC 4646 format.\r
-**/\r
+///\r
+/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive \r
+/// comparisons of strings. \r
+///\r
struct _EFI_UNICODE_COLLATION_PROTOCOL {\r
- //\r
- // general\r
- //\r
EFI_UNICODE_COLLATION_STRICOLL StriColl;\r
EFI_UNICODE_COLLATION_METAIMATCH MetaiMatch;\r
EFI_UNICODE_COLLATION_STRLWR StrLwr;\r
//\r
EFI_UNICODE_COLLATION_FATTOSTR FatToStr;\r
EFI_UNICODE_COLLATION_STRTOFAT StrToFat;\r
-\r
+ \r
+ ///\r
+ /// A Null-terminated ASCII string array that contains one or more \r
+ /// language codes. This array is specified in RFC 4646 format.\r
+ ///\r
CHAR8 *SupportedLanguages;\r
};\r
\r