ImmEnumRegisterWord function

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

Syntax


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

Parameters

hKL [in]

Input locale identifier.

lpfnEnumProc [in]

Pointer to the callback function. For more information, see EnumRegisterWordProc.

lpszReading [in, optional]

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.

dwStyle [in]

Style to enumerate. The application specifies 0 if the function is to enumerate all available styles that match the lpszReading and lpszRegister settings.

lpszRegister [in, optional]

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.

lpData [in]

Pointer to application-supplied data. The function passes this data to the callback function.

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.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Version

East Asian language support installed.

Header

Imm.h (include Windows.h)

Library

Imm32.lib

DLL

Imm32.dll

Unicode and ANSI names

ImmEnumRegisterWordW (Unicode) and ImmEnumRegisterWordA (ANSI)

See also

Input Method Manager
Input Method Manager Functions
EnumRegisterWordProc

 

 

Show: