IVsIME.Escape Method

  • Article

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

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

Syntax

'Declaration
Function Escape ( _
    hkl As IntPtr, _
    HIMC As UInteger, _
    uEsc As UInteger, _
    <OutAttribute> bstrData As String, _
    <OutAttribute> ByRef plRetVal As Integer _
) As Integer

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

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

abstract Escape : 
        hkl:IntPtr * 
        HIMC:uint32 * 
        uEsc:uint32 * 
        bstrData:string byref * 
        plRetVal:int byref -> int

function Escape(
    hkl : IntPtr, 
    HIMC : uint, 
    uEsc : uint, 
    bstrData : String, 
    plRetVal : int
) : int

Parameters

  • 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.

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

.NET Framework Security

See Also

Reference

IVsIME Interface

Microsoft.VisualStudio.Shell.Interop Namespace