ImmInstallIMEA function (immdev.h)

Article
02/22/2024

Installs an IME.

Syntax

HKL ImmInstallIMEA(
  [in] LPCSTR lpszIMEFileName,
  [in] LPCSTR lpszLayoutText
);

Parameters

[in] lpszIMEFileName

Pointer to a null-terminated string that specifies the full path of the IME.

[in] lpszLayoutText

Pointer to a null-terminated string that specifies the name of the IME and the associated layout text.

Return value

Returns the input locale identifier for the IME.

Remarks

This function is intended to be used by IME setup applications only.

Note

The immdev.h header defines ImmInstallIME 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