Share via


CToolBar::GetButtonInfo

This member function retrieves the control ID, style, and image index of the toolbar button or separator at the location specified by nIndex.

void GetButtonInfo(
   int nIndex,
   UINT& nID,
   UINT& nStyle,
   int& iImage 
) const;

Parameters

  • nIndex
    Index of the toolbar button or separator whose information is to be retrieved.

  • nID
    Reference to a UINT that is set to the command ID of the button.

  • nStyle
    Reference to a UINT that is set to the style of the button.

  • iImage
    Reference to an integer that is set to the index of the button's image within the bitmap.

Remarks

Those values are assigned to the variables referenced by nID, nStyle, and iImage. The image index is the position of the image within the bitmap that contains images for all the toolbar buttons. The first image is at position 0.

If nIndex specifies a separator, iImage is set to the separator width in pixels.

Requirements

Header: afxext.h

See Also

Reference

CToolBar Class

Hierarchy Chart

CToolBar::SetButtonInfo

CToolBar::GetItemID

Other Resources

CToolBar Members