UnicodeCollation.h File Reference

Go to the source code of this file.

Classes
struct	_EFI_UNICODE_COLLATION_PROTOCOL

Macros
#define	EFI_UNICODE_COLLATION_PROTOCOL_GUID
#define	EFI_UNICODE_COLLATION_PROTOCOL2_GUID
#define	UNICODE_COLLATION_PROTOCOL   EFI_UNICODE_COLLATION_PROTOCOL_GUID
#define	EFI_UNICODE_BYTE_ORDER_MARK   (CHAR16) (0xfeff)

Typedefs
typedef struct _EFI_UNICODE_COLLATION_PROTOCOL	EFI_UNICODE_COLLATION_PROTOCOL
typedef EFI_UNICODE_COLLATION_PROTOCOL	UNICODE_COLLATION_INTERFACE
typedef INTN(EFIAPI *	EFI_UNICODE_COLLATION_STRICOLL) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *Str1, IN CHAR16 *Str2)
typedef BOOLEAN(EFIAPI *	EFI_UNICODE_COLLATION_METAIMATCH) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN CHAR16 *Pattern)
typedef VOID(EFIAPI *	EFI_UNICODE_COLLATION_STRLWR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)
typedef VOID(EFIAPI *	EFI_UNICODE_COLLATION_STRUPR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN OUT CHAR16 *Str)
typedef VOID(EFIAPI *	EFI_UNICODE_COLLATION_FATTOSTR) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN UINTN FatSize, IN CHAR8 *Fat, OUT CHAR16 *String)
typedef BOOLEAN(EFIAPI *	EFI_UNICODE_COLLATION_STRTOFAT) (IN EFI_UNICODE_COLLATION_PROTOCOL *This, IN CHAR16 *String, IN UINTN FatSize, OUT CHAR8 *Fat)

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.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Macro Definition Documentation

EFI_UNICODE_BYTE_ORDER_MARK

#define EFI_UNICODE_BYTE_ORDER_MARK   (CHAR16) (0xfeff)

Protocol data structures and defines

EFI_UNICODE_COLLATION_PROTOCOL2_GUID

#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID

Value:

  { \
    0xa4c751fc, 0x23ae, 0x4c3e, {0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49 } \
  }

EFI_UNICODE_COLLATION_PROTOCOL_GUID

#define EFI_UNICODE_COLLATION_PROTOCOL_GUID

Value:

  { \
    0x1d85cd7f, 0xf43d, 0x11d2, {0x9a, 0xc, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  }

UNICODE_COLLATION_PROTOCOL

#define UNICODE_COLLATION_PROTOCOL   EFI_UNICODE_COLLATION_PROTOCOL_GUID

Protocol GUID name defined in EFI1.1.

Typedef Documentation

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

This	A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
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 8-bit OEM character set.
String	A pointer to a Null-terminated string. The string must be allocated in advance to hold FatSize characters.

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

This	A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
String	A pointer to a Null-terminated string.
Pattern	A pointer to a Null-terminated pattern string.

Return values

TRUE	Pattern was found in String.
FALSE	Pattern was not found in String.

EFI_UNICODE_COLLATION_PROTOCOL

typedef struct _EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL

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

This	A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
Str1	A pointer to a Null-terminated string.
Str2	A pointer to a Null-terminated string.

Return values

0	Str1 is equivalent to Str2.
>0	Str1 is lexically greater than Str2.
<0	Str1 is lexically less than Str2.

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

This	A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
String	A pointer to a Null-terminated string.

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

This	A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
String	A pointer to a Null-terminated string.
FatSize	The size of the string Fat in bytes.
Fat	A pointer to a string that contains the converted version of String using legal FAT characters from an OEM character set.

Return values

TRUE	One or more conversions failed and were substituted with '_'
FALSE	None of the conversions failed.

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

This	A pointer to the EFI_UNICODE_COLLATION_PROTOCOL instance.
String	A pointer to a Null-terminated string.

UNICODE_COLLATION_INTERFACE

typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE

Protocol defined in EFI1.1.

Variable Documentation

gEfiUnicodeCollation2ProtocolGuid

EFI_GUID gEfiUnicodeCollation2ProtocolGuid

extern

gEfiUnicodeCollationProtocolGuid

EFI_GUID gEfiUnicodeCollationProtocolGuid

extern