Función GetSystemDefaultLocaleName (winnls.h)

Artículo
08/27/2023

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

Nota Se recomienda que las aplicaciones llamen a GetUserDefaultLocaleName en preferencia sobre esta función. Esto se debe a que la configuración regional del usuario suele ser más útil y precisa para el usuario que la configuración regional del sistema.

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

Sintaxis

int GetSystemDefaultLocaleName(
  [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 de salida indicado por lpLocaleName. La longitud máxima posible de un nombre de configuración regional (incluido un carácter nulo de terminación) es el valor de LOCALE_NAME_MAX_LENGTH. Este es el tamaño recomendado.

Valor devuelto

Devuelve un valor mayor que 0 que indica la longitud del nombre de configuración regional, incluido el carácter nulo de terminación, si se ejecuta correctamente.

Esta 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.

Ejemplos

Puede encontrar un ejemplo que muestra el uso de esta función en NLS: Ejemplo de API basadas en nombres.

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