IVsIME.IsActive Method

Indicates whether or not the Input Method Editor (IME) is active for a given window.

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

Syntax

'Declaration
Function IsActive ( _
    hwnd As IntPtr, _
    <OutAttribute> ByRef pfRetVal As Integer _
) As Integer
'Usage
Dim instance As IVsIME
Dim hwnd As IntPtr
Dim pfRetVal As Integer
Dim returnValue As Integer

returnValue = instance.IsActive(hwnd, _
    pfRetVal)

int IsActive(
    IntPtr hwnd,
    out int pfRetVal
)

int IsActive(
    [InAttribute] IntPtr hwnd, 
    [OutAttribute] int% pfRetVal
)

abstract IsActive : 
        hwnd:IntPtr * 
        pfRetVal:int byref -> int

function IsActive(
    hwnd : IntPtr, 
    pfRetVal : int
) : int

Parameters

hwnd
Type: System.IntPtr
[in] Handle for the editor window.

pfRetVal
Type: System.Int32%
[out] Pointer to a Boolean. Set to true if the IME is active for the window. Set to false otherwise.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsIME::IsActive(
   [in] HWND hwnd, 
   [out] BOOL * pfRetVal
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.