RtlCompareString routine

The RtlCompareString routine compares two counted strings.

Syntax


LONG RtlCompareString(
  _In_ const STRING  *String1,
  _In_ const STRING  *String2,
  _In_       BOOLEAN CaseInSensitive
);

Parameters

String1 [in]

Pointer to the first string.

String2 [in]

Pointer to the second string.

CaseInSensitive [in]

If TRUE, case should be ignored when doing the comparison.

Return value

RtlCompareString returns a signed value that gives the results of the comparison:

Return codeDescription
Zero

String1 equals String2.

< Zero

String1 is less than String2.

> Zero

String1 is greater than String2.

 

Requirements

Target platform

Universal

Version

Available starting with Windows 2000.

Header

Ntddk.h (include Ntddk.h or Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe (kernel mode);
Ntdll.dll (user mode)

IRQL

PASSIVE_LEVEL

See also

RtlCompareUnicodeString
RtlEqualString

 

 

Send comments about this topic to Microsoft

Show: