ImmEscape function

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 ImmEscape(
  _In_    HKL    hKL,
  _In_    HIMC   hIMC,
  _In_    UINT   uEscape,
  _Inout_ LPVOID lpData
);

Parameters

hKL [in]

Input locale identifier.

hIMC [in]

Handle to the input context.

uEscape [in]

Index of the operations. For more information, see IME Escapes.

lpData [in, out]

Pointer to the data required for the escape specified in uEscape. On output, this parameter indicates the result of the escape. For more information, see IME Escapes.

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);


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

ImmEscapeW (Unicode) and ImmEscapeA (ANSI)

See also

Input Method Manager
Input Method Manager Functions

 

 

Show: