ImmEnumRegisterWordW function (imm.h)

Article
02/09/2023

Enumerates the register strings having the specified reading string, style, and register string.

Syntax

UINT ImmEnumRegisterWordW(
                 HKL                   unnamedParam1,
                 REGISTERWORDENUMPROCW unnamedParam2,
  [in, optional] LPCWSTR               lpszReading,
                 DWORD                 unnamedParam4,
  [in, optional] LPCWSTR               lpszRegister,
                 LPVOID                unnamedParam6
);

Parameters

unnamedParam1

unnamedParam2

[in, optional] lpszReading

Pointer to the reading string to enumerate. The application sets this parameter to NULL if the function is to enumerate all available reading strings that match the dwStyle and lpszRegister settings.

unnamedParam4

[in, optional] lpszRegister

Pointer to the register string to enumerate. The application sets this parameter to NULL if the function is to enumerate all register strings that match the lpszReading and dwStyle settings.

unnamedParam6

Return value

Returns the last value returned by the callback function, with the meaning defined by the application. The function returns 0 if it cannot enumerate the register strings.

Remarks

If dwStyle is set to 0 and both lpszReading and lpszRegister are set to NULL, this function enumerates all register strings in the IME dictionary.

Note

The imm.h header defines ImmEnumRegisterWord 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)
Library	Imm32.lib
DLL	Imm32.dll