Share via

EnumSystemLocales

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function enumerates the locales that are either installed on or supported by a system.

Syntax

BOOL EnumSystemLocales(
  LOCALE_ENUMPROC lpLocaleEnumProc, 
  DWORD dwFlags
);

Parameters

  • lpLocaleEnumProc
    [in] Pointer to an application-defined callback function. The EnumSystemLocales function enumerates locales by making repeated calls to this callback function. For more information, see the EnumLocalesProc callback function.

  • dwFlags
    [in] Value that specifies the locale identifiers to enumerate. The following table shows the values this parameter can take.

    Value Description

    LCID_INSTALLED

    Enumerate only installed locale identifiers.

    LCID_SUPPORTED

    Enumerate all supported locale identifiers.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call the GetLastError. The following table shows possible return values for the GetLastError function.

Value Description

ERROR_INVALID_PARAMETER

A parameter is incorrect.

Remarks

The LCID_INSTALLED and LCID_SUPPORTED flags are mutually exclusive.

For more information about LCID, see National Language support (NLS) Locale Identifiers.

Requirements

Header winnls.h
Library Coreloc.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

EnumLocalesProc

Other Resources

National Language Support (NLS) Locale Identifiers