sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sync comments on data structure to follow latest UEFI spec.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9309 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian
2009-09-24 08:56:33 +00:00
parent f60515255d
commit fbf926add9
15 changed files with 175 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
MdePkg/Include/Protocol/UnicodeCollation.h
View File

@ -49,16 +49,15 @@ typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE;
// Protocol member functions
//
/**
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 This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
@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
@retval <_0 Str1 is lexically less than Str2
@retval >0 Str1 is lexically greater than Str2
@retval <0 Str1 is lexically less than Str2
**/
typedef
@ -70,12 +69,12 @@ INTN
);
/**
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 This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
@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.
@ -90,11 +89,11 @@ BOOLEAN
);
/**
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 String A pointer to a Null-terminated Unicode string.
@param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
@param String A pointer to a Null-terminated string.
**/
typedef
@ -105,11 +104,11 @@ VOID
);
/**
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 String A pointer to a Null-terminated Unicode string.
@param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
@param String A pointer to a Null-terminated string.
**/
typedef
@ -121,14 +120,14 @@ VOID
/**
Converts an 8.3 FAT file name in an OEM character set to a Null-terminated
Unicode string.
string.
@param This Protocol instance pointer.
@param This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
@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.
@param String A pointer to a Null-terminated string. The string must
be allocated in advance to hold FatSize characters.
**/
typedef
@ -141,18 +140,17 @@ VOID
);
/**
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 This A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
@param String A pointer to a Null-terminated string.
@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 Fat A pointer to a string that contains the converted version of
String using legal FAT characters from an OEM character set.
@retval TRUE Fat is a Long File Name
@retval FALSE Fat is an 8.3 file name
@retval TRUE One or more conversions failed and were substituted with '_'
@retval FALSE None of the conversions failed.
**/
typedef
@ -166,7 +164,7 @@ BOOLEAN
///
/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive
/// comparisons of Unicode strings.
/// comparisons of strings.
///
struct _EFI_UNICODE_COLLATION_PROTOCOL {
EFI_UNICODE_COLLATION_STRICOLL StriColl;