Share via

TBBUTTONINFO (Compact 2013)

  • Article

3/28/2014

This structure contains or receives information for a specific button in a toolbar.

Syntax

typedef struct {
  UINT cbSize;
  DWORD dwMask;
  int idCommand;
  int iImage;
  BYTE fsState;
  BYTE fsStyle;
  WORD cx;
  DWORD lParam;
  LPTSTR pszText;
  int cchText;
} TBBUTTONINFOA, *LPTBBUTTONINFOA;

Members

  • cbSize
    Size of the structure, in bytes. This member must be filled in prior to sending the associated message.

  • dwMask
    Indicates which members contain valid information. This member must be filled in prior to sending the associated message. This can be a combination of one or more of the following values:

    Value

    Description

    TBIF_BYINDEX

    Specifies that wparam in TB_GETBUTTONINFO or TB_SETBUTTONINFO is an index, not an indentifier.

    TBIF_COMMAND

    The idCommand member contains valid information or is being requested.

    TBIF_IMAGE

    The iImage member contains valid information or is being requested.

    TBIF_LPARAM

    The lParam member contains valid information or is being requested.

    TBIF_SIZE

    The cx member contains valid information or is being requested.

    TBIF_STATE

    The fsState member contains valid information or is being requested.

    TBIF_STYLE

    The fsStyle member contains valid information or is being requested.

    TBIF_TEXT

    The pszText member contains valid information or is being requested.
  • idCommand
    Command identifier of the button.
  • iImage
    Image index of the button.
  • fsState
    State flags of the button. This is a combination of one or more of the toolbar button states listed in TBBUTTON.
  • fsStyle
    Style flags of the button. This is a combination of one or more of the toolbar button style values listed in Control Styles.
  • cx
    Specifies the width of the button, in pixels.
  • lParam
    Specifies the application defined 32-bit value associated with the button.
  • pszText
    Pointer to a character buffer that contains or receives the button text.
  • cchText
    Size of the buffer at pszText. If the button information is being set, this member is ignored.

Requirements

Header

commctrl.h

See Also

Reference

Toolbar Controls Structures
TBBUTTON