EnumLocalesProc

The EnumLocalesProc function is an application-defined callback function used with the EnumSystemLocales function. It receives a pointer to a string buffer containing a locale identifier. The LOCALE_ENUMPROC type defines a pointer to this callback function. EnumLocalesProc is a placeholder for the application-defined function name.

BOOL CALLBACK EnumLocalesProc(
  LPTSTR lpLocaleString   // pointer to locale identifier string
);
 

Parameters

lpLocaleString

Pointer to a string buffer containing a null-terminated locale identifier string. Note that lpLocaleString should be an LPWSTR for the Unicode (W) version of EnumLocalesProc, and an LPSTR for the ANSI (A) version of EnumLocalesProc.

Return Values

To continue enumeration, the callback function should return TRUE.

To stop enumeration, the callback function should return FALSE.

Remarks

An application registers an EnumLocalesProc function by passing its address to the EnumSystemLocales function.

Windows CE: Windows CE does not support the ANSI version of this function.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 98 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in winnls.h.
  Import Library: User-defined.

See Also

National Language Support Overview, National Language Support Functions, EnumSystemLocales