ImmRegisterWordW function (immdev.h)

Article
02/22/2024

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

Syntax

BOOL ImmRegisterWordW(
       HKL     unnamedParam1,
  [in] LPCWSTR lpszReading,
       DWORD   unnamedParam3,
  [in] LPCWSTR lpszRegister
);

Parameters

unnamedParam1

[in] lpszReading

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

unnamedParam3

[in] lpszRegister

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)

Note

The immdev.h header defines ImmRegisterWord as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only],East Asian language support installed.
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	immdev.h (include Immdev.h, Windows.h)
Library	Imm32.lib
DLL	Imm32.dll