Unicode_collation.stricoll(), Stricoll(), Func – Intel Extensible Firmware Interface User Manual

Page 412

Advertising
background image

Extensible Firmware Interface Specification

11-52

12/01/02

Version 1.10

UNICODE_COLLATION.StriColl()

Summary

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

Prototype

INTN

(EFIAPI *EFI_UNICODE_COLLATION_STRICOLL) (

IN

UNICODE_COLLATION_INTERFACE

*This,

IN

CHAR16

*s1,

IN

CHAR16

*s2

);

Parameters

This

A pointer to the

UNICODE_COLLATION_INTERFACE

instance. Type

UNICODE_COLLATION_INTERFACE

is

defined in Section 11.7.

s1

A pointer to a Null-terminated Unicode string.

s2

A pointer to a Null-terminated Unicode string.

Description

The

StriColl()

function performs a case-insensitive comparison of two Null-terminated

Unicode strings.

This function performs a case-insensitive comparison between the Unicode string

s1

and the

Unicode string

s2

using the rules for the language codes that this protocol instance supports. If

s1

is equivalent to

s2

, then 0 is returned. If

s1

is lexically less than

s2

, then a negative number will

be returned. If

s1

is lexically greater than

s2

, then a positive number will be returned. This

function allows Unicode strings to be compared and sorted.

Status Codes Returned

0

s1 is equivalent to s2.

> 0

s1 is lexically greater than s2.

< 0

s1 is lexically less than s2.

Advertising