ImmEscape

The ImmEscape function accesses capabilities of particular IMEs that are not available through other IMM APIs. and is used mainly for country-specific operations.

LRESULT ImmEscape(
  HKL hKL,       
  HIMC hIMC,     
  UINT uEscape,  
  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] Pointer to the data required for the escape specified in uEscape. Depending on the escape, when the function returns lpData may contain the result of the escape. For more information, see IME Escapes.

Return Values

Returns zero on error; otherwise, returns an operation-specific value.

Remarks

When uEscape is IME_ESC_QUERY_SUPPORT, lpData points to a buffer containing the IME escape value. For example, to see if the current IME supports IME_ESC_GETHELPFILENAME, you would use:

DWORD dwEsc = IME_ESC_GETHELPFILENAME;
LRESULT lRet = ImmEscape(hKL, hIMC, IME_ESC_QUERYSUPPORT,
     (LPVOID)&dwEsc);

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.
  Library: Use Imm32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Input Method Editor Overview, Input Method Editor Functions