GetSystemDefaultLocaleName-Funktion (winnls.h)

Artikel
03/09/2024

Ruft den Standardgebietsschemanamen des Systems ab.

Hinweis Es wird empfohlen, dass Anwendungen GetUserDefaultLocaleName vor dieser Funktion aufrufen. Dies liegt daran, dass das Benutzergebietsschema für den Benutzer im Allgemeinen nützlicher und genauer ist als das Systemgebietsschema.

Hinweis Die Anwendung sollte diese Funktion vor "GetSystemDefaultLCID " aufrufen, wenn sie nur unter Windows Vista und höher ausgeführt werden soll.

Syntax

int GetSystemDefaultLocaleName(
  [out] LPWSTR lpLocaleName,
  [in]  int    cchLocaleName
);

Parameter

[out] lpLocaleName

Zeiger auf einen Puffer, in dem diese Funktion den Gebietsschemanamen abruft.

[in] cchLocaleName

Größe des durch lpLocaleName angegebenen Ausgabepuffers in Zeichen. Die maximal mögliche Zeichenlänge eines Gebietsschemanamens (einschließlich eines endenden NULL-Zeichens) ist der Wert von LOCALE_NAME_MAX_LENGTH. Dies ist die empfohlene Größe.

Rückgabewert

Gibt einen Wert größer als 0 zurück, der die Länge des Gebietsschemanamens angibt, einschließlich des abschließenden NULL-Zeichens, falls erfolgreich.

Diese 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_INSUFFICIENT_BUFFER. Eine angegebene Puffergröße war nicht groß genug, oder sie wurde fälschlicherweise auf NULL festgelegt.

Hinweise

Diese Funktion kann Daten aus benutzerdefinierten Gebietsschemas abrufen. Es ist nicht garantiert, dass die Daten von Computer zu Computer oder zwischen Ausführungen einer Anwendung identisch sind. Wenn Ihre Anwendung Daten beibehalten oder übertragen muss, finden Sie weitere Informationen unter Verwenden persistenter Gebietsschemadaten.

Beispiele

Ein Beispiel für die Verwendung dieser Funktion finden Sie unter NLS: Beispiel für namensbasierte APIs.

Anforderungen

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