CompareStringOrdinal-Funktion (stringapiset.h)

Artikel
08/26/2023

Vergleicht zwei Unicode-Zeichenfolgen , um die binäre Äquivalenz zu testen.

Syntax

int CompareStringOrdinal(
  [in] _In_NLS_string_(cchCount1)LPCWCH lpString1,
  [in] int                              cchCount1,
  [in] _In_NLS_string_(cchCount2)LPCWCH lpString2,
  [in] int                              cchCount2,
  [in] BOOL                             bIgnoreCase
);

Parameter

[in] lpString1

Zeiger auf die erste zu vergleichende Zeichenfolge.

[in] cchCount1

Länge der durch lpString1 angegebenen Zeichenfolge. Die Anwendung liefert -1, wenn die Zeichenfolge null-beendet ist. In diesem Fall bestimmt die Funktion automatisch die Länge.

[in] lpString2

Zeiger auf die zweite zu vergleichende Zeichenfolge.

[in] cchCount2

Länge der durch lpString2 angegebenen Zeichenfolge. Die Anwendung liefert -1, wenn die Zeichenfolge null-beendet ist. In diesem Fall bestimmt die Funktion automatisch die Länge.

[in] bIgnoreCase

TRUE , wenn die Funktion einen Vergleich ohne Beachtung der Groß-/Kleinschreibung unter Verwendung der Tabelleninformationen des Betriebssystems in Großbuchstaben durchführt. Die Anwendung legt diesen Parameter auf FALSE fest, wenn die Funktion die Zeichenfolgen genau so vergleichen soll, wie sie übergeben werden. Beachten Sie, dass 1 der einzige numerische Wert ist, der verwendet werden kann, um einen true-Wert für diesen booleschen Parameter anzugeben, der nicht zu einem ungültigen Parameterfehler führt. Boolesche Werte für diesen Parameter funktionieren wie erwartet.

Rückgabewert

Gibt bei erfolgreicher Ausführung einen der folgenden Werte zurück. Um die C-Laufzeitkonvention für den Vergleich von Zeichenfolgen beizubehalten, kann der Wert 2 von einem Rückgabewert ungleich null subtrahiert werden. Dann ist die Bedeutung von <0, ==0 und >0 mit der C-Runtime konsistent.

CSTR_LESS_THAN. Der von lpString1 angegebene Wert ist kleiner als der von lpString2 angegebene Wert.
CSTR_EQUAL. Der von lpString1 angegebene Wert entspricht dem wert, der von lpString2 angegeben wird.
CSTR_GREATER_THAN. Der von lpString1 angegebene Wert ist größer als der von lpString2 angegebene Wert.

Die Funktion gibt 0 zurück, wenn sie nicht erfolgreich ist. Um erweiterte Fehlerinformationen zu erhalten, kann die Anwendung GetLastError aufrufen, wodurch einer der folgenden Fehlercodes zurückgegeben werden kann:

ERROR_INVALID_PARAMETER. Jeder der Parameterwerte war ungültig.

Hinweise

Diese Funktion testet auf binäre Gleichheit, nicht auf linguistische Gleichheit. Informationen zur Verwendung der Funktion für die Ordnungszahlsortierung finden Sie unter Behandeln der Sortierung in Ihren Anwendungen.

Anwendungen, die sich mit linguistischer Gleichheit befassen, sollten CompareString, CompareStringEx, lstrcmp oder lstrcmpi verwenden. Weitere Informationen zur linguistischen Sortierung finden Sie unter Behandeln der Sortierung in Ihren Anwendungen.

Ab Windows 8: CompareStringOrdinal wird in Stringapiset.h deklariert. Vor Windows 8 wurde es in Winnls.h deklariert.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	stringapiset.h (Einschließen von Windows.h)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll