DownlevelGetParentLocaleLCID

  • Article

Retrieves the locale identifier for the parent of the supplied locale.

Note: This function is used only by applications that run on pre-Windows Vista operating systems. Its use requires the download package. Applications that only run on Windows Vista and later should call GetLocaleInfo with LCType set to LOCALE_SPARENT.

LCIDDownlevelGetParentLocaleLCID(LCID Locale);

Parameters

  • Locale
    [in] Locale identifier of the locale for which to retrieve the parent locale identifier. You can use the MAKELCID macro to create a locale identifier or use one of the following predefined values. For more information, see Locale Identifier Constants and Strings.

    • LOCALE_INVARIANT
    • LOCALE_SYSTEM_DEFAULT
    • LOCALE_USER_DEFAULT

    Windows Vista and later: The following custom locale identifiers are also supported.

    • LOCALE_CUSTOM_DEFAULT
    • LOCALE_CUSTOM_UI_DEFAULT
    • LOCALE_CUSTOM_UNSPECIFIED

Return Values

Returns the parent locale identifier if successful.

This function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError. GetLastError returns ERROR_INVALID_PARAMETER if the specified locale identifier is not valid.

Remarks

The required header file and DLL are part of the "Microsoft NLS Downlevel Data Mapping APIs" Microsoft link download, available at the Microsoft Download Center Microsoft link.

Requirements

**  Redistributable:** Requires Microsoft NLS Downlevel Data Mapping APIs on Windows XP (SP2 or later) or Windows Vista.
**  Header:** Declared in Nlsdl.h.
**  Library:** Use Nlsdl.dll.

See Also

Mapping Locale Data on Downlevel Systems, National Language Support Functions