IVsIME.Escape(IntPtr, UInt32, UInt32, String, Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Provides access to ImmEscape, a method enabling access to features, often country-specific, of particular Input Method Editors (IME).

public:
 int Escape(IntPtr hkl, System::UInt32 HIMC, System::UInt32 uEsc, System::String ^ bstrData, [Runtime::InteropServices::Out] int % plRetVal);

public int Escape (IntPtr hkl, uint HIMC, uint uEsc, string bstrData, out int plRetVal);

abstract member Escape : nativeint * uint32 * uint32 * string * int -> int

Public Function Escape (hkl As IntPtr, HIMC As UInteger, uEsc As UInteger, bstrData As String, ByRef plRetVal As Integer) As Integer

Parameters

hkl

IntPtr

nativeint

[in] Input locale identifier.

HIMC

UInt32

[in] Handle to the input context.

uEsc

UInt32

[in] The operation to perform. One of the IME Escapes values.

bstrData

String

[in] The string containing information on which to perform the operation.

plRetVal

Int32

[out] Pointer to a status value. Returns zero for errors. For more information, see IME Escapes.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The Escape method wraps a call to IME Escapes, which returns a 64-bit value (LRESULT) on 64-bit Windows, but Escape returns only the least significant 32 bits of the result. If this is not suitable in a 64-bit context, call IME Escapes directly.

COM Signature

From vsshell.idl:

HRESULT IVsIME::Escape(  
   [in] HKL hkl,   
   [in] HIMC himc,   
   [in] UINT uEsc,   
   [in, out] BSTR bstrData,   
   [out] LONG * plRetVal  
);