IDockingWindow::ResizeBorderDW method (shobjidl_core.h)

Article
02/22/2024

Notifies the docking window object that the frame's border space has changed. In response to this method, the IDockingWindow implementation must call SetBorderSpaceDW, even if no border space is required or a change is not necessary.

Syntax

HRESULT ResizeBorderDW(
  LPCRECT  prcBorder,
  IUnknown *punkToolbarSite,
  BOOL     fReserved
);

Parameters

prcBorder

Type: LPCRECT

Pointer to a RECT structure that contains the frame's available border space.

punkToolbarSite

Type: IUnknown*

Pointer to the site's IUnknown interface. The docking window object should call the QueryInterface method for this interface, requesting IID_IDockingWindowSite. The docking window object then uses that interface to negotiate its border space. It is the docking window object's responsibility to release this interface when it is no longer needed.

fReserved

Type: BOOL

Reserved. This parameter should always be zero.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The prcBorder parameter contains the frame's entire available border space. The docking window object should negotiate its border space and then use this information to position itself.

For example, if the docking window object requires 25 pixels at the top of the border space, it should negotiate for this through the following steps:

Allocate a BORDERWIDTHS structure and set its top member to 25.
Call RequestBorderSpaceDW to request the space.
If the request is approved by RequestBorderSpaceDW, call SetBorderSpaceDW to allocate the space.

The docking window object can then position its window at prcBorder->left and prcBorder->top. The width of the docking window object's window is determined by subtracting prcBorder->left from prcBorder->right. Its height is contained in the top member of the BORDERWIDTHS structure.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shlobj.h)
DLL	Shell32.dll (version 4.71 or later)