EnumLocalesProc callback function

An application-defined callback function that processes enumerated locale information provided by the EnumSystemLocales function. The LOCALE_ENUMPROC type defines a pointer to this callback function. EnumLocalesProc is a placeholder for the application-defined function name.

Syntax

BOOL CALLBACK EnumLocalesProc(
  _In_ LPTSTR lpLocaleString
);

Parameters

  • lpLocaleString [in]
    Pointer to a buffer containing a null-terminated locale identifier string.

Return value

Returns TRUE to continue enumeration or FALSE otherwise.

Remarks

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

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)

See also

National Language Support

National Language Support Functions

EnumSystemLocales