The EnumCalendarInfo 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 EnumCalendarInfo 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. This continues until either the last applicable calendar is found or the callback function returns FALSE.
BOOL EnumCalendarInfo(
| CALINFO_ENUMPROC lpCalInfoEnumProc, | // pointer to enumeration callback function |
| LCID Locale, | // locale whose calendar information is of interest |
| CALID Calendar, | // calendar whose information is of interest |
| CALTYPE CalType | // type of calendar information of interest |
| ); |
Parameters
lpCalInfoEnumProc
Points to an application-defined callback function. For more information, see the EnumCalendarInfoProc callback function.
Locale
Specifies the locale to retrieve calendar information for. 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. |
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. |
| 1 | Gregorian (localized) |
| 2 | Gregorian (English strings always) |
| 3 | Japanese era |
| 4 | Year of the Republic of China |
| 5 | Tangun Era (Korea) |
CalType
Indicates the type of calendar information to be returned. 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
See Also