Platform SDK: International Features

ImmRegisterWord

The ImmRegisterWord function registers a string into the dictionary of the IME associated with the specified input locale.

BOOL ImmRegisterWord(
  HKL hKL,              
  LPCTSTR lpszReading,  
  DWORD dwStyle,        
  LPCTSTR lpszRegister  
);

Parameters

hKL
[in] Input locale identifier.
lpszReading
[in] Pointer to a null-terminated string specifying the reading string associated with the string to register.
dwStyle
[in] Specifies the style of the register string. This parameter can be any of the following.
Value Meaning
IME_REGWORD_STYLE_EUDC The string is in the EUDC range.
any value in the range from IME_REGWORD_STYLE_USER_FIRST to IME_REGWORD_STYLE_USER_LAST The string has a private style maintained by the specified IME. See the Remarks section.

lpszRegister
[in] Pointer to a null-terminated string specifying the string to register.

Return Values

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero.

Remarks

An IME ISV can define any private styles for an IME within the IME_REGWORD_STYLE_USER_FIRST and IME_REGWORD_STYLE_USER_LAST values. For example:

#define MSIME_NOUN (IME_REGWORD_STYLE_USER_FIRST)
#define MSIME_VERB (IME_REGWORD_STYLE_USER_FIRST + 1)

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.
  Library: Use Imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Input Method Editor Overview, Input Method Editor Functions