RtlCompareUnicodeString - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
#ifndef _NTRTL_H
/**
* The RtlCompareUnicodeString routine compares two Unicode strings.
*
* \param[in] String1 Pointer to the first string.
* \param[in] String2 Pointer to the second string.
* \param[in] CaseInSensitive If TRUE, case should be ignored when doing the comparison.
* \return A signed value that gives the results of the comparison.
* \sa https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/wdm/nf-wdm-rtlcompareunicodestring
*/
_Must_inspect_result_
NTSYSAPI
LONG
NTAPI
RtlCompareUnicodeString(
_In_ PCUNICODE_STRING String1,
_In_ PCUNICODE_STRING String2,
_In_ BOOLEAN CaseInSensitive
);
View code on GitHub// wdm.h
NTSYSAPI LONG RtlCompareUnicodeString(
[in] PCUNICODE_STRING String1,
[in] PCUNICODE_STRING String2,
[in] BOOLEAN CaseInSensitive
);
View the official Windows Driver Kit DDI reference// wdm.h
LONG RtlCompareUnicodeString(
_In_ PCUNICODE_STRING String1,
_In_ PCUNICODE_STRING String2,
_In_ BOOLEAN CaseInSensitive
);
View the official Win32 development documentationThis function is documented in Windows Driver Kit.
The RtlCompareUnicodeString routine compares two Unicode strings.
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.
RtlCompareUnicodeString 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. |
Compares two Unicode strings.
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.
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. |
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 2000 Professional [desktop apps only] |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| Target platform |
Universal |
| Header |
Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h) |
| Library |
Ntdll.lib |
| DLL |
Ntdll.dll |