Função LCIDToLocaleName (winnls.h)

Converte um identificador de localidade em um nome de localidade.

Sintaxe

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

Parâmetros

[in] Locale

Identificador de localidade a ser convertido. Você pode usar a macro MAKELCID para criar um identificador de localidade ou usar um dos valores predefinidos a seguir.

• LOCALE_INVARIANT
• LOCALE_SYSTEM_DEFAULT
• LOCALE_USER_DEFAULT

• LOCALE_CUSTOM_DEFAULT
• LOCALE_CUSTOM_UI_DEFAULT
• LOCALE_CUSTOM_UNSPECIFIED

[out, optional] lpName

Ponteiro para um buffer no qual essa função recupera o nome da localidade ou um dos valores predefinidos a seguir.

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

[in] cchName

Tamanho, em caracteres, do buffer de nome de localidade. O comprimento máximo possível de um nome de localidade, incluindo um caractere nulo de terminação, é LOCALE_NAME_MAX_LENGTH. Esse é o tamanho recomendado para fornecer para esse parâmetro.

Como alternativa, o aplicativo pode definir esse parâmetro como 0. Nesse caso, a função retorna o tamanho necessário para o buffer de nome de localidade.

[in] dwFlags

Antes do Windows 7: Reservados; deve ser sempre 0.

A partir do Windows 7: Pode ser definido como LOCALE_ALLOW_NEUTRAL_NAMES para permitir o retorno de um nome neutro.

Retornar valor

Retorna a contagem de caracteres, incluindo o caractere nulo de terminação, no nome da localidade, se tiver êxito. Se a função for bem-sucedida e o valor de cchName for 0, o valor retornado será o tamanho necessário, em caracteres (incluindo nulos), para o buffer de nome de localidade.

A função retornará 0 se não for bem-sucedida. Para obter informações de erro estendidas, o aplicativo pode chamar GetLastError, que pode retornar um dos seguintes códigos de erro:

• ERROR_INSUFFICIENT_BUFFER. Um tamanho de buffer fornecido não era grande o suficiente ou estava definido incorretamente como NULL.
• ERROR_INVALID_PARAMETER. Qualquer um dos valores de parâmetro era inválido.

Requisitos

Confira também

LocaleNameToLCID

Suporte a idiomas nacionais

Funções de suporte à linguagem nacional