Função GetUserDefaultLocaleName (winnls.h)

  • Artigo

Recupera o nome de localidade padrão do usuário.

Nota O aplicativo deve chamar essa função em preferência para GetUserDefaultLCID se projetado para ser executado somente no Windows Vista e posterior.

 

Sintaxe

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

Parâmetros

[out] lpLocaleName

Ponteiro para um buffer no qual essa função recupera o nome da localidade.

[in] cchLocaleName

Tamanho, em caracteres, do buffer indicado por lpLocaleName. 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 nesse parâmetro.

Retornar valor

Retorna o tamanho do buffer que contém o nome da localidade, incluindo o caractere nulo de terminação, se bem-sucedido.

Nota Em sistemas de usuário único, o valor retornado é o mesmo retornado por GetSystemDefaultLocaleName.

 

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 foi definido incorretamente como NULL.

Comentários

Essa função pode recuperar dados de localidades personalizadas. Não há garantia de que os dados sejam iguais de computador para computador ou entre execuções de um aplicativo. Se o aplicativo precisar persistir ou transmitir dados, consulte Usando dados de localidade persistente.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho winnls.h (inclua Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Getlocaleinfoex

GetSystemDefaultLocaleName

GetUserDefaultLCID

Suporte à linguagem nacional

Funções de suporte à linguagem nacional