IVsIME.IsActive(IntPtr, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int IsActive(IntPtr hwnd, [Runtime::InteropServices::Out] int % pfRetVal);

public int IsActive (IntPtr hwnd, out int pfRetVal);

abstract member IsActive : nativeint * int -> int

Public Function IsActive (hwnd As IntPtr, ByRef pfRetVal As Integer) As Integer

Parameters

hwnd: IntPtr
nativeint

[in] Handle for the editor window.

pfRetVal: Int32

[out] Pointer to a Boolean. Set to true if the IME is active for the window. Set to false otherwise.

Returns

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

Applies to