Unicode Collation Protocol
Version 1.02 12/12/00 233
13.1.6 UNICODE_COLLATION.StrToFat()
Summary
Converts a Null-terminated Unicode string to legal characters in a FAT filename using an OEM
character set.
Prototype
BOOLEAN
(EFIAPI *EFI_UNICODE_COLLATION_STRTOFAT) (
IN UNICODE_COLLATION_INTERFACE *This,
IN CHAR16 *String,
IN UINTN FatSize,
OUT CHAR8 *Fat
);
Parameters
This A pointer to the UNICODE_COLLATION_INTERFACE
instance. Type UNICODE_COLLATION_INTERFACE is
defined in Section 13.1.
String A pointer to a Null-terminated Unicode string.
FatSize The size of the string Fat in bytes.
Fat A pointer to a Null-terminated string that contains an 8.3 file
name using an OEM character set.
Description
This function converts the first FatSize Unicode characters of String to the legal FAT
characters in an OEM character set and stores then in the string Fat. The Unicode characters ‘.’
(period) and ‘ ‘ (space) are ignored for this conversion. If no valid mapping from the Unicode
character to a FAT character is available, then it is substituted with an '_'. This function returns
FALSE if the return string Fat is an 8.3 file name. This function returns TRUE if the return string
Fat is a Long File Name.
Status Codes Returned
TRUE Fat is a Long File Name.
FALSE Fat is an 8.3 file name.