EnumCalendarInfoEx

The EnumCalendarInfoEx function enumerates calendar information for a specified locale. The CalType parameter specifies the type of calendar information to enumerate. The function returns the specified calendar information for all applicable calendars for the locale, or for a single requested calendar, depending on the value of the Calendar parameter.

The EnumCalendarInfoEx function enumerates the calendar information by calling an application-defined callback function. It passes the callback function a pointer to a string buffer containing the requested calendar information and a Calendar ID (CALID). This continues until either the last applicable calendar is found or the callback function returns FALSE.

BOOL EnumCalendarInfo(
  CALINFO_ENUMPROCEX lpCalInfoEnumProcEx,
                   // pointer to enumeration callback function
  LCID Locale,     // locale of interest
  CALID Calendar,  // calendar whose information is of interest
  CALTYPE CalType  // type of calendar information of interest
);
 

Parameters

lpCalInfoEnumProcEx

Points to an application-defined callback function. For more information, see the EnumCalendarInfoProcEx callback function.

Locale

Specifies the locale for which to retrieve calendar information. This parameter can be a locale identifier created by the MAKELCID macro, or one of the following predefined values:

LOCALE_SYSTEM_DEFAULT	Default system locale.
LOCALE_USER_DEFAULT	Default user locale.
LOCALE_NEUTRAL	Default language-neutral locale.

Calendar

Specifies the calendar for which information is requested. The following values are defined:

Value	Meaning
ENUM_ALL_CALENDARS	Enumerate all applicable calendars for the locale specified by Locale.
CAL_GREGORIAN	Gregorian (localized)
CAL_GREGORIAN_US	Gregorian (English strings always)
CAL_JAPAN	Japanese Emperor Era
CAL_TAIWAN	Taiwan Region Era
CAL_KOREA	Korean Tangun Era
CAL_HIJRI	Hijri (Arabic Lunar)
CAL_THAI	Thai
CAL_HEBREW	Hebrew
CAL_GREGORIAN_ME_FRENCH	Gregorian Middle East French
CAL_GREGORIAN_ARABIC	Gregorian Arabic
CAL_GREGORIAN_XLIT_ENGLISH	Gregorian transliterated English
CAL_GREGORIAN_XLIT_FRENCH	Gregorian transliterated French

CalType

Indicates the type of calendar information to be returned. See the listing of constant values in Calendar Type Information. Note that only one CALTYPE value can be specified per call of this function.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError may return one of the following error codes:

ERROR_BADDB
ERROR_INVALID_FLAGS
ERROR_INVALID_PARAMETER

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Requires Windows 98 or later.
  Windows CE: Unsupported.
  Header: Declared in winnls.h.
  Import Library: Use kernel32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

National Language Support Overview, National Language Support Functions, EnumCalendarInfoProc, EnumDateFormats