IsValidNLSVersion function

Determines if the NLS version is valid for a given NLS function.

Syntax

DWORD IsValidNLSVersion(
  NLS_FUNCTION       function,
  LPCWSTR            lpLocaleName,
  LPNLSVERSIONINFOEX lpVersionInformation
);

Parameters

function

The NLS capability to query. This value must be COMPARE_STRING. See the SYSNLS_FUNCTION enumeration.

lpLocaleName

Pointer to a locale name, or one of the following predefined values.

lpVersionInformation

Pointer to an NLSVERSIONINFOEX structure. The application must initialize the dwNLSVersionInfoSize member to sizeof(NLSVERSIONINFOEX).

Return Value

Returns a nonzero value if the NLS version is valid, or zero if the version is invalid.

Remarks

Initialize the NLSVERSIONINFOEX structure by calling GetNLSVersionEx. See the Remarks for GetNLSVersionEx for a discussion on how the members of NLSVERSIONINFOEX can be used to determine if a sort version has changed and you need to reindex data.

Beginning in Windows 8: If your app passes language tags to this function from the Windows.Globalization namespace, it must first convert the tags by calling ResolveLocaleName.

Requirements

   
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header winnls.h (include Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See Also

GetNLSVersionEx

Handling Sorting in Your Applications

NLSVERSIONINFOEX