EnumLocalesProc

Overview

Group

Quick Info

Windows NT
Yes
Win95
No
Win32s
Yes
Import Library
user-defined
Header File
winnls.h
Unicode
WinNT
Platform Notes
LOCALE_ENUMPROC

An EnumLocalesProc function is an application-defined callback function. It is called as a result of a call to the EnumSystemLocales function, and receives a pointer to a string buffer containing a locale identifier.

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
EnumLocalesProc is a placeholder for an application-defined function name.

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

A value of type LOCALE_ENUMPROC is a pointer to an EnumLocalesProc function.