GetUserPreferredUILanguages-Funktion (winnls.h)

Artikel
03/04/2024

Ruft Informationen zur Einstellung der Anzeigesprache ab. Weitere Informationen finden Sie unter Benutzeroberflächensprachverwaltung.

Syntax

BOOL GetUserPreferredUILanguages(
  [in]            DWORD   dwFlags,
  [out]           PULONG  pulNumLanguages,
  [out, optional] PZZWSTR pwszLanguagesBuffer,
  [in, out]       PULONG  pcchLanguagesBuffer
);

Parameter

[in] dwFlags

Flags zur Identifizierung des Sprachformats und der Filterung. Die folgenden Flags geben das Sprachformat an, das für die Anzeigesprachenliste verwendet werden soll. Die Flags schließen sich gegenseitig aus, und der Standardwert ist MUI_LANGUAGE_NAME.

Wert	Bedeutung
MUI_LANGUAGE_ID	Abrufen der Sprachzeichenfolgen im Sprachbezeichner
MUI_LANGUAGE_NAME	Rufen Sie die Sprachzeichenfolgen im Format des Sprachnamens ab.

[out] pulNumLanguages

Zeiger auf die Anzahl der in pwszLanguagesBuffer abgerufenen Sprachen.

[out, optional] pwszLanguagesBuffer

Optional. Zeiger auf einen Puffer, in dem diese Funktion eine geordnete, durch NULL getrennte Anzeigespracheliste im von dwflags angegebenen Format abruft. Diese Liste endet mit zwei NULL-Zeichen.

Wenn dieser Parameter auf NULL und pcchLanguagesBuffer auf 0 festgelegt ist, ruft die Funktion die erforderliche Größe des Sprachpuffers in pcchLanguagesBuffer ab. Die erforderliche Größe enthält die beiden NULL-Zeichen.

[in, out] pcchLanguagesBuffer

Zeiger auf die Größe in Zeichen für den Sprachpuffer, der durch pwszLanguagesBuffer angegeben wird. Bei erfolgreicher Rückgabe von der Funktion enthält der Parameter die Größe des abgerufenen Sprachpuffers.

Wenn dieser Parameter auf 0 und pwszLanguagesBuffer auf NULL festgelegt ist, ruft die Funktion die erforderliche Größe des Sprachpuffers in pcchLanguagesBuffer ab.

Rückgabewert

Gibt TRUE zurück, wenn dies erfolgreich war, oder andernfalls FALSE . Um erweiterte Fehlerinformationen zu erhalten, kann die Anwendung die GetLastError-Funktion aufrufen, die einen der folgenden Fehlercodes zurückgeben kann:

ERROR_INSUFFICIENT_BUFFER. Eine angegebene Puffergröße war nicht groß genug, oder sie wurde fälschlicherweise auf NULL festgelegt.

Wenn die Funktion aus einem anderen Grund fehlschlägt, sind die Werte von pulNumLanguages und pcchLanguagesBuffer nicht definiert.

Hinweise

Wenn MUI_LANGUAGE_ID angegeben ist, sind die abgerufenen Sprachzeichenfolgen hexadezimale Sprachbezeichner, die nicht den führenden 0x enthalten und 4 Zeichen lang sind. Beispielsweise wird en-US als "0409" und en als "0009" zurückgegeben.

Die Anzeigesprache darf nicht mehr als eine Benutzeroberflächen-Sprachpaket (LIP)-Sprache enthalten, die einem zusätzlichen Gebietsschema entspricht. Wenn die Liste mehrere dieser Sprachen enthält und die Anwendung im Aufruf der Funktion MUI_LANGUAGE_ID angibt, enthält der Sprachpuffer "1400" für diese Sprache. Diese Zeichenfolge entspricht dem Hexadezimalwert von LOCALE_CUSTOM_UI_DEFAULT.

Die von dieser Funktion abgerufene Sprachliste weist die folgenden Merkmale auf:

Jede Sprache stellt ein gültiges NLS-Gebietsschema dar.
Jede Sprache ist auf dem Betriebssystem installiert.
Die Liste enthält einen Eintrag für jede Sprache ohne doppelte Einträge.
Wenn die Liste leer ist oder diese Überprüfungskriterien nicht erfüllt, wird stattdessen die Liste der bevorzugten Benutzeroberflächensprachen des Systems verwendet.

C#-Signatur

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
        static extern System.Boolean GetUserPreferredUILanguages(
            System.UInt32 dwFlags,
            ref System.UInt32 pulNumLanguages,
            System.IntPtr pwszLanguagesBuffer,
            ref System.UInt32 pcchLanguagesBuffer
            );

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

Siehe auch

GetSystemPreferredUILanguages-Funktion, GetThreadPreferredUILanguages-Funktion, GetThreadUILanguage-Funktion, SetThreadPreferredUILanguages-Funktion, Mehrsprachige Benutzeroberfläche, Mehrsprachige Benutzeroberflächenfunktionen

Freigeben über