RtlCompareString - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
#ifndef _NTRTL_H

/**
 * The RtlCompareString routine compares two counted strings.
 *
 * \param String1 A pointer to the first counted string.
 * \param String2 A pointer to the second counted string.
 * \param CaseInSensitive If `TRUE`, case is ignored when comparing the strings.
 * \return A signed value that is negative, zero, or positive if String1 is less than, equal to, or greater than String2.
 * \sa https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/ntddk/nf-ntddk-rtlcomparestring
 */
_Must_inspect_result_
NTSYSAPI
LONG
NTAPI
RtlCompareString(
    _In_ PSTRING String1,
    _In_ PSTRING String2,
    _In_ BOOLEAN CaseInSensitive
    );

#endif

View code on GitHub
// ntddk.h

NTSYSAPI LONG RtlCompareString(
  [in] const STRING *String1,
  [in] const STRING *String2,
  [in] BOOLEAN      CaseInSensitive
);
View the official Windows Driver Kit DDI reference

NtDoc

This function is documented in Windows Driver Kit.

Windows Driver Kit DDI reference (nf-ntddk-rtlcomparestring)

RtlCompareString function

Description

The RtlCompareString routine compares two counted strings.

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

See also

RtlCompareUnicodeString

RtlEqualString