Edit

Share via

IAccessibilityDockingService::DockWindow method (shobjidl.h)

  • Article

Docks the specified window handle to the specified monitor handle.

Syntax

HRESULT DockWindow(
  [in] HWND                                 hwnd,
  [in] HMONITOR                             hMonitor,
       UINT                                 cyRequested,
  [in] IAccessibilityDockingServiceCallback *pCallback
);

Parameters

[in] hwnd

The accessibility application window that will be docked on the passed monitor handle.

[in] hMonitor

The monitor on which the accessibility application window will be docked.

cyRequested

TBD

[in] pCallback

The callback pointer on which the accessibility application will receive the Undock notification.

Return value

This method can return one of these values.

Return code Description
S_OK
 Success.
E_INVALIDARG
 The window handle or monitor handle is not valid.
E_ACCESSDENIED
 The calling process is not a UIAcess accessibility application or the calling process does not own the window.
IMM_E_DOCKOCCUPIED
 There is already another window occupying the docking space. Only one window can be docked at a time.
IMM_E_INSUFFICIENTHEIGHT
 The requested uHeight is larger than the maximum allowed docking height for the specified monitor. However, if this error code is being returned, it means that this monitor does support docking, though at a height indicated by a call to the GetAvailableSize method.
HRESULT_FROM_WIN32(ERROR_INVALID_MONITOR_HANDLE)
 The monitor specified by the monitor handle does not support docking.

Requirements

Requirement Value
Target Platform Windows
Header shobjidl.h

See also

IAccessibilityDockingService