LANGGROUPLOCALE_ENUMPROCA callback function (winnls.h)

Article
02/22/2024

An application-defined callback function that processes enumerated language group locale information provided by the EnumLanguageGroupLocales function. The LANGGROUPLOCALE_ENUMPROC type defines a pointer to this callback function. EnumLanguageGroupLocalesProc is a placeholder for the application-defined function name.

Syntax

LANGGROUPLOCALE_ENUMPROCA LanggrouplocaleEnumproca;

BOOL LanggrouplocaleEnumproca(
  LGRPID unnamedParam1,
  LCID unnamedParam2,
  LPSTR unnamedParam3,
  LONG_PTR unnamedParam4
)
{...}

Parameters

unnamedParam1

unnamedParam2

unnamedParam3

unnamedParam4

Return value

Returns TRUE to continue enumeration or FALSE otherwise.

Remarks

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

Note

The winnls.h header defines LANGGROUPLOCALE_ENUMPROC as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	winnls.h (include Windows.h)