ImmUnregisterWord function

Removes a register string from the dictionary of the IME associated with the specified input locale.

Syntax


BOOL ImmUnregisterWord(
  _In_ HKL     hKL,
  _In_ LPCTSTR lpszReading,
  _In_ DWORD   dwStyle,
  _In_ LPCTSTR lpszUnregister
);

Parameters

hKL [in]

Input locale identifier.

lpszReading [in]

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

dwStyle [in]

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

ValueMeaning
IME_REGWORD_STYLE_EUDC

The string is in the end-user-defined character (EUDC) range.

Any value from IME_REGWORD_STYLE_USER_FIRST to IME_REGWORD_STYLE_USER_LAST

The string is in a private style maintained by the specified IME.

 

lpszUnregister [in]

Pointer to a null-terminated string specifying the register string to remove.

Return value

Returns a nonzero value if successful, or 0 otherwise.

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

ImmUnregisterWordW (Unicode) and ImmUnregisterWordA (ANSI)

See also

Input Method Manager
Input Method Manager Functions

 

 

Show: