Função GetSystemDefaultLocaleName (winnls.h)

Artigo
03/04/2024

Recupera o nome da localidade padrão do sistema.

Nota É recomendável que os aplicativos chamem GetUserDefaultLocaleName em preferência sobre essa função. Isso ocorre porque a localidade do usuário geralmente é mais útil e precisa para o usuário do que a localidade do sistema.

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

Sintaxe

int GetSystemDefaultLocaleName(
  [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 de saída indicado por lpLocaleName. O comprimento máximo de caractere possível de um nome de localidade (incluindo um caractere nulo de terminação) é o valor de LOCALE_NAME_MAX_LENGTH. Esse é o tamanho recomendado.

Retornar valor

Retorna um valor maior que 0 que indica o comprimento do nome da localidade, incluindo o caractere nulo de terminação, se bem-sucedido.

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

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.

Exemplos

Um exemplo mostrando o uso dessa função pode ser encontrado em NLS: Exemplo de APIs baseadas em nome.

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