The EnumTimeFormats function enumerates the time formats that are available for a specified locale. The function enumerates the time formats by passing a pointer to a string buffer containing a time format to an application-defined callback function. It continues to do so until the last time format is found or the callback function returns FALSE.
BOOL EnumTimeFormats(
| TIMEFMT_ENUMPROC lpTimeFmtEnumProc, | // pointer to enumeration callback function |
| LCID Locale, | // locale whose time formats are of interest |
| DWORD dwFlags | // currently unused |
| ); |
Parameters
lpTimeFmtEnumProc
Points to an application-defined callback function. See the EnumTimeFormatsProc callback function for further details.
Locale
Specifies the locale to retrieve time format 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. |
dwFlags
Currently unused. Must be zero.
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_INVALID_PARAMETER
ERROR_BADDB
ERROR_INVALID FLAGS
See Also