IActiveIMMIME::EscapeA method

Executes Active Input Method Editor (IME)-specific subfunctions and is used mainly for country-specific and region-specific functions. (ANSI implementation).

Syntax

HRESULT EscapeA(
  [in]      HKL     hKL,
  [in]      HIMC    hIMC,
  [in]      UINT    uEscape,
  [in, out] LPVOID  pData,
  [out]     LRESULT *plResult
);

Parameters

  • hKL [in]
    A handle to the keyboard layout.

  • hIMC [in]
    A handle to the input context.

  • uEscape [in]
    An unsigned integer that contains the index of the subfunction.

  • pData [in, out]
    The address of a buffer that contains subfunction-specific data.

  • plResult [out]
    The address of the LRESULT variable that receives the escape-specific value that is returned by the operation.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method maps to the ImmEscape function that is documented in the Windows Software Development Kit (SDK).

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Dimm.h

IDL

Dimm.idl

See also

IActiveIMMIME

EscapeW