REGISTERWORDENUMPROCW callback function (imm.h)

Article
02/22/2024

An application-defined callback function used with the ImmEnumRegisterWord function. It is used to process data of register strings. The REGISTERWORDENUMPROC type defines a pointer to this callback function. EnumRegisterWordProc is a placeholder for the application-defined function name.

Syntax

REGISTERWORDENUMPROCW Registerwordenumprocw;

int Registerwordenumprocw(
  [in] LPCWSTR lpszReading,
       DWORD unnamedParam2,
  [in] LPCWSTR lpszString,
       LPVOID unnamedParam4
)
{...}

Parameters

[in] lpszReading

Pointer to a null-terminated string specifying the matched reading string.

unnamedParam2

The style of the register string.

[in] lpszString

Pointer to a null-terminated string specifying the matched register string.

unnamedParam4

Application-supplied data.

Return value

Returns a nonzero value to continue enumeration, or 0 to stop enumeration.

Remarks

An application must register this function by passing its address to the ImmEnumRegisterWord function.

Note

The imm.h header defines REGISTERWORDENUMPROC 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 XP [desktop apps only],East Asian language support installed.
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imm.h (include Immdev.h, Windows.h)