ImmEscapeA function (imm.h)
Accesses capabilities of particular IMEs that are not available through other IME API functions. This function is used mainly for country-specific operations.
Syntax
LRESULT ImmEscapeA(
HKL unnamedParam1,
HIMC unnamedParam2,
UINT unnamedParam3,
LPVOID unnamedParam4
);
Parameters
unnamedParam1
unnamedParam2
unnamedParam3
unnamedParam4
Return value
Returns an operation-specific value if successful, or 0 otherwise.
Remarks
When uEscape is set to IME_ESC_QUERY_SUPPORT, lpData indicates the buffer containing the IME escape value. For example, to see if the current IME supports IME_ESC_GETHELPFILENAME, your application uses the following call:
DWORD dwEsc = IME_ESC_GETHELPFILENAME;
LRESULT lRet = ImmEscape(hKL,
hIMC,
IME_ESC_QUERY_SUPPORT,
(LPVOID)&dwEsc);
Note
The imm.h header defines ImmEscape as an alias that 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 is 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 |