Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function adds the Closebutton ( X) to the upper right corner of the command bands control. You can also use it to add the Helpbutton ( ?) and the OKbutton.

Syntax

BOOL CommandBands_AddAdornments(
  HWND 
hwndCmdBands, 
  HINSTANCE 
hinst, 
  DWORD 
dwFlags, 
  LPREBARBANDINFO 
prbbi
);

Parameters

hwndCmdBands

Handle to the command bands control's window. This handle is returned when the command bands control is created by the CommandBands_Createfunction.

hinst

Handle to the application instance.

dwFlags

Specifies the optional buttons to be added to the top band of the command bands control. This parameter can be a combination of the following values, or zero if neither of the optional buttons are needed.

Value Description Message

CMDBAR_HELP

Help button

WM_HELP

CMDBAR_OK

OK button

WM_COMMAND (with IDOK as the message identifier)

prbbi

Pointer to a REBARBANDINFOstructure. Use this structure to customize the band that holds the adornments. This parameter can be NULL.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

By default the adornments band is created with an identifier of 0xFFFFFFFF. You can use the REBARBANDINFOstructure you pass in the prbbiparameter to override this identifier.

Requirements

Header commctrl.h
Library commctrl.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also