iPXE
Data Structures | Macros | Typedefs | Functions | Variables
UnicodeCollation.h File Reference

Unicode Collation protocol that follows the UEFI 2.0 specification. More...

Go to the source code of this file.

Data Structures

struct  _EFI_UNICODE_COLLATION_PROTOCOL
 The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive comparisons of strings. More...
 

Macros

#define EFI_UNICODE_COLLATION_PROTOCOL_GUID
 
#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID
 
#define UNICODE_COLLATION_PROTOCOL   EFI_UNICODE_COLLATION_PROTOCOL_GUID
 Protocol GUID name defined in EFI1.1. More...
 
#define EFI_UNICODE_BYTE_ORDER_MARK   (CHAR16) (0xfeff)
 Protocol data structures and defines. More...
 

Typedefs

typedef struct _EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL
 
typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE
 Protocol defined in EFI1.1. More...
 
typedef INTN(EFIAPIEFI_UNICODE_COLLATION_STRICOLL) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *Str1, IN CHAR16 *Str2)
 Performs a case-insensitive comparison of two Null-terminated strings. More...
 
typedef BOOLEAN(EFIAPIEFI_UNICODE_COLLATION_METAIMATCH) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN CHAR16 *Pattern)
 Performs a case-insensitive comparison of a Null-terminated pattern string and a Null-terminated string. More...
 
typedef VOID(EFIAPIEFI_UNICODE_COLLATION_STRLWR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)
 Converts all the characters in a Null-terminated string to lower case characters. More...
 
typedef VOID(EFIAPIEFI_UNICODE_COLLATION_STRUPR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)
 Converts all the characters in a Null-terminated string to upper case characters. More...
 
typedef VOID(EFIAPIEFI_UNICODE_COLLATION_FATTOSTR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN UINTN FatSize, IN CHAR8 *Fat, OUT CHAR16 *String)
 Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string. More...
 
typedef BOOLEAN(EFIAPIEFI_UNICODE_COLLATION_STRTOFAT) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN UINTN FatSize, OUT CHAR8 *Fat)
 Converts a Null-terminated string to legal characters in a FAT filename using an OEM character set. More...
 

Functions

 FILE_LICENCE (BSD2_PATENT)
 

Variables

EFI_GUID gEfiUnicodeCollationProtocolGuid
 
EFI_GUID gEfiUnicodeCollation2ProtocolGuid
 

Detailed Description

Unicode Collation protocol that follows the UEFI 2.0 specification.

This protocol is used to allow code running in the boot services environment to perform lexical comparison functions on Unicode strings for given languages.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UnicodeCollation.h.

Macro Definition Documentation

◆ EFI_UNICODE_COLLATION_PROTOCOL_GUID

#define EFI_UNICODE_COLLATION_PROTOCOL_GUID
Value:
{ \
0x1d85cd7f, 0xf43d, 0x11d2, {0x9a, 0xc, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
}

Definition at line 16 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_PROTOCOL2_GUID

#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID
Value:
{ \
0xa4c751fc, 0x23ae, 0x4c3e, {0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49 } \
}

Definition at line 21 of file UnicodeCollation.h.

◆ UNICODE_COLLATION_PROTOCOL

#define UNICODE_COLLATION_PROTOCOL   EFI_UNICODE_COLLATION_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

Definition at line 31 of file UnicodeCollation.h.

◆ EFI_UNICODE_BYTE_ORDER_MARK

#define EFI_UNICODE_BYTE_ORDER_MARK   (CHAR16) (0xfeff)

Protocol data structures and defines.

Definition at line 41 of file UnicodeCollation.h.

Typedef Documentation

◆ EFI_UNICODE_COLLATION_PROTOCOL

Definition at line 26 of file UnicodeCollation.h.

◆ UNICODE_COLLATION_INTERFACE

Protocol defined in EFI1.1.

Definition at line 36 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_STRICOLL

typedef INTN(EFIAPI * EFI_UNICODE_COLLATION_STRICOLL) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *Str1, IN CHAR16 *Str2)

Performs a case-insensitive comparison of two Null-terminated strings.

Parameters
ThisA pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
Str1A pointer to a Null-terminated string.
Str2A pointer to a Null-terminated string.
Return values
0Str1 is equivalent to Str2.
>0Str1 is lexically greater than Str2.
<0Str1 is lexically less than Str2.

Definition at line 61 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_METAIMATCH

typedef BOOLEAN(EFIAPI * EFI_UNICODE_COLLATION_METAIMATCH) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN CHAR16 *Pattern)

Performs a case-insensitive comparison of a Null-terminated pattern string and a Null-terminated string.

Parameters
ThisA pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
StringA pointer to a Null-terminated string.
PatternA pointer to a Null-terminated pattern string.
Return values
TRUEPattern was found in String.
FALSEPattern was not found in String.

Definition at line 81 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_STRLWR

typedef VOID(EFIAPI * EFI_UNICODE_COLLATION_STRLWR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)

Converts all the characters in a Null-terminated string to lower case characters.

Parameters
ThisA pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
StringA pointer to a Null-terminated string.

Definition at line 97 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_STRUPR

typedef VOID(EFIAPI * EFI_UNICODE_COLLATION_STRUPR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)

Converts all the characters in a Null-terminated string to upper case characters.

Parameters
ThisA pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
StringA pointer to a Null-terminated string.

Definition at line 112 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_FATTOSTR

typedef VOID(EFIAPI * EFI_UNICODE_COLLATION_FATTOSTR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN UINTN FatSize, IN CHAR8 *Fat, OUT CHAR16 *String)

Converts an 8.3 FAT file name in an OEM character set to a Null-terminated string.

Parameters
ThisA pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
FatSizeThe size of the string Fat in bytes.
FatA pointer to a Null-terminated string that contains an 8.3 file name using an 8-bit OEM character set.
StringA pointer to a Null-terminated string. The string must be allocated in advance to hold FatSize characters.

Definition at line 131 of file UnicodeCollation.h.

◆ EFI_UNICODE_COLLATION_STRTOFAT

typedef BOOLEAN(EFIAPI * EFI_UNICODE_COLLATION_STRTOFAT) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN UINTN FatSize, OUT CHAR8 *Fat)

Converts a Null-terminated string to legal characters in a FAT filename using an OEM character set.

Parameters
ThisA pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
StringA pointer to a Null-terminated string.
FatSizeThe size of the string Fat in bytes.
FatA pointer to a string that contains the converted version of String using legal FAT characters from an OEM character set.
Return values
TRUEOne or more conversions failed and were substituted with '_'
FALSENone of the conversions failed.

Definition at line 154 of file UnicodeCollation.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT  )

Variable Documentation

◆ gEfiUnicodeCollationProtocolGuid

EFI_GUID gEfiUnicodeCollationProtocolGuid

◆ gEfiUnicodeCollation2ProtocolGuid

EFI_GUID gEfiUnicodeCollation2ProtocolGuid