FindNLSString-Funktion (winnls.h)

Artikel
08/27/2023

Sucht eine Unicode-Zeichenfolge (Breitzeichen) oder deren Entsprechung in einer anderen Unicode-Zeichenfolge für ein durch den Bezeichner angegebenes Gebietsschema.

Vorsicht Da Zeichenfolgen mit sehr unterschiedlichen binären Darstellungen als identisch vergleichen können, kann diese Funktion bestimmte Sicherheitsbedenken auslösen. Weitere Informationen finden Sie in der Diskussion zu Vergleichsfunktionen unter Sicherheitsüberlegungen: Internationale Features.

Hinweis Aus Interoperabilitätsgründen sollte die Anwendung die FindNLSStringEx-Funktion bevorzugen, da Microsoft zur Verwendung von Gebietsschemanamen anstelle von Gebietsschemabezeichnern für neue Gebietsschemas migriert. Obwohl FindNLSString benutzerdefinierte Gebietsschemas unterstützt, sollten die meisten Anwendungen FindNLSStringEx für diese Art von Unterstützung verwenden.

Syntax

int FindNLSString(
  [in]            LCID    Locale,
  [in]            DWORD   dwFindNLSStringFlags,
  [in]            LPCWSTR lpStringSource,
  [in]            int     cchSource,
  [in]            LPCWSTR lpStringValue,
  [in]            int     cchValue,
  [out, optional] LPINT   pcchFound
);

Parameter

[in] Locale

Gebietsschemabezeichner , der das Gebietsschema angibt. Sie können das MAKELCID-Makro verwenden, um einen Bezeichner zu erstellen oder einen der folgenden vordefinierten Werte zu verwenden.

Windows Vista und höher: Die folgenden benutzerdefinierten Gebietsschemabezeichner werden ebenfalls unterstützt.

[in] dwFindNLSStringFlags

Flags, die Details des Suchvorgangs angeben. Ausführliche Definitionen finden Sie im DwFindNLSStringFlags-Parameter von FindNLSStringEx.

[in] lpStringSource

Zeiger auf die Quellzeichenfolge, in der die Funktion nach der durch lpStringValue angegebenen Zeichenfolge sucht.

[in] cchSource

Größe der durch lpStringSource angegebenen Zeichenfolge in Zeichen mit Ausnahme des abschließenden NULL-Zeichens. Die Anwendung kann für diesen Parameter nicht 0 oder eine andere negative Zahl als -1 angeben. Die Anwendung gibt -1 an, wenn die Quellzeichenfolge NULL-beendet ist und die Funktion die Größe automatisch berechnen soll.

[in] lpStringValue

Zeiger auf die Suchzeichenfolge, nach der die Funktion in der Quellzeichenfolge durchsucht.

[in] cchValue

Größe der durch lpStringValue angegebenen Zeichenfolge in Zeichen mit Ausnahme des abschließenden NULL-Zeichens. Die Anwendung kann für diesen Parameter nicht 0 oder eine andere negative Zahl als -1 angeben. Die Anwendung gibt -1 an, wenn die Suchzeichenfolge null-beendet ist und die Funktion die Größe automatisch berechnen soll.

[out, optional] pcchFound

Zeiger auf einen Puffer, der die Länge der von der Funktion gefundenen Zeichenfolge enthält. Weitere Informationen finden Sie im PcchFound-Parameter von FindNLSStringEx.

Rückgabewert

Gibt einen 0-basierten Index in die Quellzeichenfolge zurück, die von lpStringSource angegeben wird, wenn dies erfolgreich ist. In Kombination mit dem Wert in pcchFound gibt dieser Index die genaue Position der gesamten gefundenen Zeichenfolge in der Quellzeichenfolge an. Ein Rückgabewert von 0 ist ein fehlerfreier Index in der Quellzeichenfolge, und die übereinstimmende Zeichenfolge befindet sich in der Quellzeichenfolge bei Offset 0.

Die Funktion gibt -1 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_FLAGS. Die für Flags angegebenen Werte waren ungültig.
ERROR_INVALID_PARAMETER. Jeder der Parameterwerte war ungültig.
ERROR_SUCCESS. Die Aktion wurde erfolgreich abgeschlossen, lieferte aber keine Ergebnisse.

Hinweise

Weitere Informationen finden Sie unter Hinweise zu FindNLSStringEx.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winnls.h (windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll