GetSystemDefaultLocaleName, fonction (winnls.h)

Article
03/04/2024

Récupère le nom des paramètres régionaux par défaut du système.

Note Il est recommandé aux applications d’appeler GetUserDefaultLocaleName de préférence par rapport à cette fonction. Cela est dû au fait que les paramètres régionaux de l’utilisateur sont généralement plus utiles et précis pour l’utilisateur que les paramètres régionaux système.

Note L’application doit appeler cette fonction de préférence à GetSystemDefaultLCID si elle est conçue pour s’exécuter uniquement sur Windows Vista et versions ultérieures.

Syntaxe

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

Paramètres

[out] lpLocaleName

Pointeur vers une mémoire tampon dans laquelle cette fonction récupère le nom des paramètres régionaux.

[in] cchLocaleName

Taille, en caractères, de la mémoire tampon de sortie indiquée par lpLocaleName. La longueur de caractères maximale possible d’un nom de paramètres régionaux (y compris un caractère null de fin) est la valeur de LOCALE_NAME_MAX_LENGTH. Il s’agit de la taille recommandée.

Valeur retournée

Retourne une valeur supérieure à 0 qui indique la longueur du nom des paramètres régionaux, y compris le caractère null de fin, en cas de réussite.

Cette fonction retourne 0 si elle ne réussit pas. Pour obtenir des informations d’erreur étendues, l’application peut appeler GetLastError, qui peut retourner l’un des codes d’erreur suivants :

ERROR_INSUFFICIENT_BUFFER. Une taille de mémoire tampon fournie n’était pas assez grande ou elle a été incorrectement définie sur NULL.

Remarques

Cette fonction peut récupérer des données à partir de paramètres régionaux personnalisés. Il n’est pas garanti que les données soient identiques d’un ordinateur à l’autre ou entre les exécutions d’une application. Si votre application doit conserver ou transmettre des données, consultez Utilisation des données de paramètres régionaux persistants.

Exemples

Vous trouverez un exemple montrant l’utilisation de cette fonction dans NLS : Exemple d’API basées sur le nom.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	winnls.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll