IVsIME::Escape Method (IntPtr, UInt32, UInt32, String^, Int32)

 

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

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

int Escape(
	IntPtr hkl,
	unsigned int HIMC,
	unsigned int uEsc,
	String^ bstrData,
	[OutAttribute] int% plRetVal
)

Parameters

hkl
Type: System::IntPtr

[in] Input locale identifier.

HIMC
Type: System::UInt32

[in] Handle to the input context.

uEsc
Type: System::UInt32

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

bstrData
Type: System::String^

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

plRetVal
Type: System::Int32

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

Return Value

Type: System::Int32

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

The Escape method wraps a call to , 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 directly.ime_396bime_396b

From vsshell.idl:

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