Edit

IDockingWindowFrame::AddToolbar method (shlobj.h)

  • Article

Adds the specified IDockingWindow object to the frame.

Syntax

HRESULT AddToolbar(
  [in] IUnknown *punkSrc,
  [in] PCWSTR   pwszItem,
       DWORD    dwAddFlags
);

Parameters

[in] punkSrc

Type: IUnknown*

A pointer to the IDockingWindow object to be added.

[in] pwszItem

Type: PCWSTR

A pointer to a null-terminated, Unicode, application-defined string that is used to identify the docking window object.

dwAddFlags

Type: DWORD

Flags that apply to the docking window object that is being added. One or more of the following values.

0

The docking window is a regular, visible docking window.

DWFAF_HIDDEN (0x0001)

The docking window is added but is not shown. To show it at a later time, call its IDockingWindow::ShowDW method.

DWFAF_GROUP1 (0x0002)

Reserved. Do not use.

DWFAF_GROUP2 (0x0004)

Reserved. Do not use.

DWFAF_AUTOHIDE (0x0010)

Reserved. Do not use.

Return value

Type: HRESULT

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

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 shlobj.h
DLL Shell32.dll (version 4.71 or later)

See also

IDockingWindowFrame

IDockingWindowSite