Partager via

CommandBar_AddToolTips (Compact 2013)

  • Article

3/28/2014

This macro adds ToolTip strings to the command bar. A ToolTip control is a small pop-up window that displays a line of descriptive text giving the purpose of a button on the command bar.

Syntax

BOOL CommandBar_AddToolTips(
  HWND hwndCB, 
  UINT uNumToolTips, 
  LPTSTR lpToolTips
);

Parameters

  • hwndCB
    Handle to the command bar's window. This handle is returned by the CommandBar_Create function when the command bar is created.
  • uNumToolTips
    Unsigned integer that contains the number of ToolTip strings in the array specified in the lpToolTips parameter.
  • lpToolTips
    Array of long pointers to strings that are displayed when the ToolTip control is active. The array must contain the same number of elements as specified in the uNumToolTips parameter.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

Only command-bar buttons can have ToolTip strings; menus and combo boxes cannot.

CommandBar_AddToolTips does not copy the array of ToolTip strings you pass to it. It uses the memory address you pass in the lpToolTips parameter. Do not release the memory allocated for the ToolTip string array until the program exits.

Requirements

Header

commctrl.h

See Also

Reference

Command Bars Macros
CommandBar_Create