ImmRegisterWord function

Registers a string with the dictionary of the IME associated with the specified input locale.

Syntax


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

Parameters

hKL [in]

Input locale identifier.

lpszReading [in]

Pointer to a null-terminated reading string associated with the string to register.

dwStyle [in]

Style of the string to register. This parameter can have any of the following values.

ValueMeaning
IME_REGWORD_STYLE_EUDC

The string is in the end-user-defined (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 for more details.

 

lpszRegister [in]

Pointer to the null-terminated string to register.

Return value

Returns a nonzero value if successful, or 0 otherwise.

Remarks

An IME independent software vendor (ISV) can define private styles for an IME in 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

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

ImmRegisterWordW (Unicode) and ImmRegisterWordA (ANSI)

See also

Input Method Manager
Input Method Manager Functions

 

 

Community Additions

ADD
Show:
© 2015 Microsoft