Share via


IVsIME.GetDefaultWindow Method

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

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

Syntax

'Declaration
Function GetDefaultWindow ( _
    hwnd As IntPtr, _
    <OutAttribute> ByRef phRetVal As IntPtr _
) As Integer
int GetDefaultWindow(
    IntPtr hwnd,
    out IntPtr phRetVal
)
int GetDefaultWindow(
    [InAttribute] IntPtr hwnd, 
    [OutAttribute] IntPtr% phRetVal
)
abstract GetDefaultWindow : 
        hwnd:IntPtr * 
        phRetVal:IntPtr byref -> int 
function GetDefaultWindow(
    hwnd : IntPtr, 
    phRetVal : IntPtr
) : int

Parameters

  • hwnd
    Type: System.IntPtr
    [in] The handle for the editor window.
  • phRetVal
    Type: System.IntPtr%
    [out] If successful, the default window for the IME class. Otherwise, nulla null reference (Nothing in Visual Basic).

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

.NET Framework Security

See Also

Reference

IVsIME Interface

Microsoft.VisualStudio.Shell.Interop Namespace