EnumTimeFormatsProcEx callback function

Article
20/03/2018

An application-defined callback function that processes enumerated time format information provided by the EnumTimeFormatsEx function. The TIMEFMT_ENUMPROCEX type defines a pointer to this callback function. EnumTimeFormatsProcEx is a placeholder for the application-defined function name.

Syntax

c++

BOOL CALLBACK EnumTimeFormatsProcEx(
  _In_ LPWSTR lpTimeFormatString,
  _In_ LPARAM lParam
);

Parameters

lpTimeFormatString [in]
Pointer to a buffer containing a null-terminated time format string.
lParam [in]
An application-provided input parameter of EnumTimeFormatsEx. This value is especially useful for multi-threaded applications, since it can be used to pass thread-specific data to this callback function.

Return value

Returns TRUE to continue enumeration or FALSE otherwise.

Remarks

An EnumTimeFormatsProcEx function can carry out any desired task. The application registers this function by passing its address to the EnumTimeFormatsEx function.

This callback function can process enumerated data from custom locales. Data is not guaranteed to be the same from computer to computer or between runs of an application. If your application must persist or transmit data, see Using Persistent Locale Data.

Requirements

Minimum supported client	Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Header	Winnls.h (include Windows.h)

Share via