ImmEnumRegisterWord

This function enumerates the register strings having the specified reading string, style, and register string.

At a Glance

Syntax

UINT ImmEnumRegisterWord( HKL hKL,
REGISTERWORDENUMPROC lpfnEnumProc, LPCTSTR lpszReading,
DWORD dwStyle, LPCTSTR lpszRegister, LPVOID lpData );

Parameters

hKL

[in] Ignored; set to NULL. Windows CE does not support true keyboard layouts.

lpfnEnumProc

[in] Long pointer to the callback function. For more information, see EnumRegisterWordProc.

lpszReading

[in] Long pointer to the reading string to be enumerated. If NULL, this function enumerates all available reading strings that match with the specified dwStyle and lpszRegister.

dwStyle

[in] Specifies the style to be enumerate. If zero, this function enumerates all available styles that match with the specified lpszReading and lpszRegister.

lpszRegister

[in] Long pointer to the register string to enumerate. If NULL, this function enumerates all register strings that match with the specified lpszReading and dwStyle.

lpData

[in] Long pointer to application-supplied data. The function passes this parameter to the callback function.

Return Values

The last value returned by the callback function indicates success. Its meaning is defined by the application. Zero indicates that the function cannot enumerate the register strings.

Remarks

If dwStyle is zero and both lpszReading and lpszRegister are NULL, the ImmEnumRegisterWord function enumerates all register strings in the IME dictionary.