GetNLSVersion function (winnls.h)
Retrieves information about the current version of a specified NLS capability for a locale specified by identifier.
Syntax
BOOL GetNLSVersion(
[in] NLS_FUNCTION Function,
[in] LCID Locale,
[in, out] LPNLSVERSIONINFO lpVersionInformation
);
Parameters
[in] Function
The NLS capability to query. This value must be COMPARE_STRING. See the SYSNLS_FUNCTION enumeration.
[in] Locale
Locale identifier that specifies the locale. You can use the MAKELCID macro to create an identifier or use one of the following predefined values.
Windows Vista and later: The following custom locale identifiers are also supported.[in, out] lpVersionInformation
Pointer to an NLSVERSIONINFO structure. The application must initialize the dwNLSVersionInfoSize member to sizeof(NLSVERSIONINFO)
.
Return value
Returns TRUE if and only if the application has supplied valid values in lpVersionInformation, or FALSE otherwise. To get extended error information, the application can call GetLastError, which can return one of the following error codes:
- ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL.
- ERROR_INVALID_FLAGS. The values supplied for flags were not valid.
- ERROR_INVALID_PARAMETER. Any of the parameter values was invalid.
Remarks
This function allows an application such as Active Directory to determine if an NLS change affects the locale identifier used for a particular index table. If it does not, there is no need to re-index the table. For more information, see Handling Sorting in Your Applications.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2008 [desktop apps only] |
Target Platform | Windows |
Header | winnls.h (include Windows.h) |
Library | Kernel32.lib |
DLL | Kernel32.dll |
See also
Handling Sorting in Your Applications