IVsIME.GetDefaultWindow(IntPtr, IntPtr) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Retrieves the default window for the Input Method Editor (IME) class that is active. Wrapper for a call to ImmGetDefaultIMEWnd.

public:
 int GetDefaultWindow(IntPtr hwnd, [Runtime::InteropServices::Out] IntPtr % phRetVal);

public int GetDefaultWindow (IntPtr hwnd, out IntPtr phRetVal);

abstract member GetDefaultWindow : nativeint * nativeint -> int

Public Function GetDefaultWindow (hwnd As IntPtr, ByRef phRetVal As IntPtr) As Integer

Parameters

hwnd: IntPtr
nativeint

[in] The handle for the editor window.

phRetVal: IntPtr
nativeint

[out] If successful, the default window for the IME class. Otherwise, null.

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::GetDefaultWindow(  
   [in] HWND hwnd,   
   [out] HWND* phRetVal  
);

Applies to