The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

EnumCalendarInfo function

Enumerates calendar information for a specified locale.

Note To receive a calendar identifier in addition to calendar information, the application should use the EnumCalendarInfoEx function. Another reason for preferring this function is that Microsoft is migrating toward the use of locale names instead of locale identifiers for new locales, for interoperability reasons.

Note Any application that will be run only on Windows Vista and later should use EnumCalendarInfoExEx in preference to EnumCalendarInfo.

Syntax

C++


BOOL EnumCalendarInfo(
  _In_ CALINFO_ENUMPROC pCalInfoEnumProc,
  _In_ LCID             Locale,
  _In_ CALID            Calendar,
  _In_ CALTYPE          CalType
);

Parameters

pCalInfoEnumProc [in]

Pointer to an application-defined callback function. For more information, see EnumCalendarInfoProc.

Locale [in]

Locale identifier that specifies the locale for which to retrieve calendar information. You can use the MAKELCID macro to create a locale identifier or use one of the following predefined values.

Calendar [in]

Calendar identifier that specifies the calendar for which information is requested. Note that this identifier can be ENUM_ALL_CALENDARS, to enumerate all calendars that are associated with the locale.

CalType [in]

Type of calendar information. For more information, see Calendar Type Information. Only one calendar type can be specified per call to this function, except where noted.

Return value

Returns a nonzero value if successful, or 0 otherwise. To get extended error information, the application can call GetLastError, which can return one of the following error codes:

ERROR_INVALID_FLAGS. The values supplied for flags were not valid.
ERROR_INVALID_PARAMETER. Any of the parameter values was invalid.

Remarks

See Remarks for EnumCalendarInfoEx.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Winnls.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll
Unicode and ANSI names	EnumCalendarInfoW (Unicode) and EnumCalendarInfoA (ANSI)