Función GetUserDefaultLocaleName (winnls.h)

Recupera el nombre de configuración regional predeterminado del usuario.

Nota La aplicación debe llamar a esta función en preferencia a GetUserDefaultLCID si está diseñada para ejecutarse solo en Windows Vista y versiones posteriores.

 

Sintaxis

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

Parámetros

[out] lpLocaleName

Puntero a un búfer en el que esta función recupera el nombre de la configuración regional.

[in] cchLocaleName

Tamaño, en caracteres, del búfer indicado por lpLocaleName. La longitud máxima posible de un nombre de configuración regional, incluido un carácter nulo de terminación, es LOCALE_NAME_MAX_LENGTH. Este es el tamaño recomendado que se debe proporcionar en este parámetro.

Valor devuelto

Devuelve el tamaño del búfer que contiene el nombre de la configuración regional, incluido el carácter nulo de terminación, si se ejecuta correctamente.

Nota En los sistemas de usuario único, el valor devuelto es el mismo que el devuelto por GetSystemDefaultLocaleName.

 

La función devuelve 0 si no se realiza correctamente. Para obtener información de error extendida, la aplicación puede llamar a GetLastError, que puede devolver uno de los siguientes códigos de error:

  • ERROR_INSUFFICIENT_BUFFER. Un tamaño de búfer proporcionado no era lo suficientemente grande o se estableció incorrectamente en NULL.

Comentarios

Esta función puede recuperar datos de configuraciones regionales personalizadas. No se garantiza que los datos sean los mismos desde el equipo al equipo o entre ejecuciones de una aplicación. Si la aplicación debe conservar o transmitir datos, consulte Uso de datos de configuración regional persistente.

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [aplicaciones de escritorio | aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino Windows
Encabezado winnls.h (incluye Windows.h)
Library Kernel32.lib
Archivo DLL Kernel32.dll

Vea también

GetLocaleInfoEx

GetSystemDefaultLocaleName

GetUserDefaultLCID

Compatibilidad con idiomas nacionales

Funciones de compatibilidad con idiomas nacionales