Función GetNLSVersion (winnls.h)

Artículo
03/08/2023

Recupera información sobre la versión actual de una funcionalidad NLS especificada para una configuración regional especificada por identificador.

Nota Por motivos de interoperabilidad, la aplicación debe preferir la función GetNLSVersionEx a GetNLSVersion porque Microsoft está migrando hacia el uso de nombres de configuración regional en lugar de identificadores de configuración regional para las nuevas configuraciones regionales. Esta recomendación se aplica especialmente a las configuraciones regionales personalizadas, para las que GetNLSVersionEx recupera suficiente información para determinar si el comportamiento de ordenación ha cambiado. Cualquier aplicación que se ejecute solo en Windows Vista y versiones posteriores debe usar GetNLSVersionEx o, al menos, pasar la estructura NLSVERSIONINFOEX al llamar a GetNLSVersion para obtener datos de control de versiones de ordenación adicionales.

Sintaxis

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

Parámetros

[in] Function

La funcionalidad NLS que se va a consultar. Este valor debe ser COMPARE_STRING. Consulte la enumeración SYSNLS_FUNCTION .

[in] Locale

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

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

[in, out] lpVersionInformation

Puntero a una estructura NLSVERSIONINFO . La aplicación debe inicializar el miembro dwNLSVersionInfoSize en sizeof(NLSVERSIONINFO).

Nota En Windows Vista y versiones posteriores, la función también puede proporcionar información de versión en una estructura NLSVERSIONINFOEX .

Valor devuelto

Devuelve TRUE si y solo si la aplicación ha proporcionado valores válidos en lpVersionInformation o FALSE en caso contrario. 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_FLAGS. Los valores proporcionados para las marcas no eran válidos.
ERROR_INVALID_PARAMETER. Cualquiera de los valores de parámetro no era válido.

Comentarios

Esta función permite a una aplicación como Active Directory determinar si un cambio nlS afecta al identificador de configuración regional usado para una tabla de índice determinada. Si no es así, no es necesario volver a indexar la tabla. Para obtener más información, consulte Control de la ordenación en las aplicaciones.

Requisitos


Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winnls.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll