Função GetNLSVersion (winnls.h)

Artigo
08/27/2023

Recupera informações sobre a versão atual de um recurso de NLS especificado para uma localidade especificada pelo identificador.

Nota Por motivos de interoperabilidade, o aplicativo deve preferir a função GetNLSVersionEx a GetNLSVersion porque a Microsoft está migrando para o uso de nomes de localidade em vez de identificadores de localidade para novas localidades. Essa recomendação se aplica especialmente a localidades personalizadas, para as quais GetNLSVersionEx recupera informações suficientes para determinar se o comportamento de classificação foi alterado. Qualquer aplicativo executado somente no Windows Vista e posterior deve usar GetNLSVersionEx ou pelo menos passar a estrutura NLSVERSIONINFOEX ao chamar GetNLSVersion para obter dados adicionais de controle de versão de classificação.

Sintaxe

BOOL GetNLSVersion(
  [in]      NLS_FUNCTION     Function,
  [in]      LCID             Locale,
  [in, out] LPNLSVERSIONINFO lpVersionInformation
);

Parâmetros

[in] Function

A funcionalidade nls para consultar. Esse valor deve ser COMPARE_STRING. Consulte a enumeração SYSNLS_FUNCTION .

[in] Locale

Identificador de localidade que especifica a localidade. Você pode usar a macro MAKELCID para criar um identificador ou usar um dos seguintes valores predefinidos.

Windows Vista e posterior: Também há suporte para os seguintes identificadores de localidade personalizados.

[in, out] lpVersionInformation

Ponteiro para uma estrutura NLSVERSIONINFO . O aplicativo deve inicializar o membro dwNLSVersionInfoSize para sizeof(NLSVERSIONINFO).

Nota No Windows Vista e posteriores, a função pode, como alternativa, fornecer informações de versão em uma estrutura NLSVERSIONINFOEX .

Valor retornado

Retornará TRUE se e somente se o aplicativo tiver fornecido valores válidos em lpVersionInformation ou FALSE caso contrário. 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.
ERROR_INVALID_FLAGS. Os valores fornecidos para sinalizadores não eram válidos.
ERROR_INVALID_PARAMETER. Qualquer um dos valores de parâmetro era inválido.

Comentários

Essa função permite que um aplicativo como o Active Directory determine se uma alteração de NLS afeta o identificador de localidade usado para uma tabela de índice específica. Se isso não acontecer, não será necessário indexar novamente a tabela. Para obter mais informações, consulte Manipulando a classificação em seus aplicativos.

Requisitos


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