RtlCompareString function (ntddk.h)

The RtlCompareString routine compares two counted strings.

Syntax

NTSYSAPI LONG RtlCompareString(
  [in] const STRING *String1,
  [in] const STRING *String2,
  [in] BOOLEAN      CaseInSensitive
);

Parameters

[in] String1

Pointer to the first string.

[in] String2

Pointer to the second string.

[in] CaseInSensitive

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 code Description
Zero
String1 equals String2.
< Zero
String1 is less than String2.
> Zero
String1 is greater than String2.

Requirements

Requirement Value
Minimum supported client Available starting with Windows 2000.
Target Platform Universal
Header ntddk.h (include Ntddk.h, Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe (kernel mode); Ntdll.dll (user mode)
IRQL PASSIVE_LEVEL

See also

RtlCompareUnicodeString

RtlEqualString