ImmUnregisterWordA function (imm.h)

Article
02/22/2024

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

Syntax

BOOL ImmUnregisterWordA(
       HKL    unnamedParam1,
  [in] LPCSTR lpszReading,
       DWORD  unnamedParam3,
  [in] LPCSTR lpszUnregister
);

Parameters

unnamedParam1

[in] lpszReading

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

unnamedParam3

[in] lpszUnregister

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

Return value

Returns a nonzero value if successful, or 0 otherwise.

Remarks

Note

The imm.h header defines ImmUnregisterWord 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	imm.h (include Immdev.h, Windows.h)
Library	Imm32.lib
DLL	Imm32.dll