IsValidNLSVersion function

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

Syntax

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

Parameters

function [in]

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

lpLocaleName [in, optional]

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

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

lpVersionInformation [in]

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

See also

Handling Sorting in Your Applications

GetNLSVersionEx

NLSVERSIONINFOEX