Función LCIDToLocaleName (winnls.h)

Convierte un identificador de configuración regional en un nombre de configuración regional.

Nota Para configuraciones regionales personalizadas, incluidas las creadas por Microsoft, las aplicaciones deben preferir nombres de configuración regional en los identificadores de configuración regional.

 

Sintaxis

int LCIDToLocaleName(
  [in]            LCID   Locale,
  [out, optional] LPWSTR lpName,
  [in]            int    cchName,
  [in]            DWORD  dwFlags
);

Parámetros

[in] Locale

Identificador de configuración regional que se va a traducir. Puede usar la macro MAKELCID para crear un identificador de configuración regional o usar uno de los siguientes valores predefinidos.

• LOCALE_INVARIANT
• LOCALE_SYSTEM_DEFAULT
• LOCALE_USER_DEFAULT

Windows Vista: También se admiten los siguientes identificadores de configuración regional personalizados.

• LOCALE_CUSTOM_DEFAULT
• LOCALE_CUSTOM_UI_DEFAULT
• LOCALE_CUSTOM_UNSPECIFIED

[out, optional] lpName

Puntero a un búfer en el que esta función recupera el nombre de la configuración regional o uno de los siguientes valores predefinidos.

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

[in] cchName

Tamaño, en caracteres, del búfer de nombres de configuración regional. 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 para este parámetro.

Como alternativa, la aplicación puede establecer este parámetro en 0. En este caso, la función devuelve el tamaño necesario para el búfer de nombres de configuración regional.

[in] dwFlags

Antes de Windows 7: Reservados; siempre debe ser 0.

A partir de Windows 7: Se puede establecer en LOCALE_ALLOW_NEUTRAL_NAMES para permitir la devolución de un nombre neutro.

Valor devuelto

Devuelve el recuento de caracteres, incluido el carácter nulo de terminación, en el nombre de la configuración regional si se ejecuta correctamente. Si la función se ejecuta correctamente y el valor de cchName es 0, el valor devuelto es el tamaño necesario, en caracteres (incluidos valores NULL), para el búfer de nombres de configuración regional.

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.
• ERROR_INVALID_PARAMETER. Cualquiera de los valores de parámetro no era válido.

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 (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll

Vea también

LocaleNameToLCID

Compatibilidad con idiomas nacionales

Funciones de compatibilidad con idiomas nacionales