IVsIME.GetDefaultWindow(IntPtr, IntPtr) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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