Share via


CPagerCtrl::GetButtonState

Retrieves the state of the specified scroll button in the current pager control.

DWORD GetButtonState(
      int iButton
) const;

Requirements

Header: afxcmn.h

Parameters

Parameter

Description

[in] iButton

Indicates the button for which the state is retrieved. If the pager control style is PGS_HORZ, specify PGB_TOPORLEFT for the left button and PGB_BOTTOMORRIGHT for the right button. If the pager control style is PGS_VERT, specify PGB_TOPORLEFT for the top button and PGB_BOTTOMORRIGHT for the bottom button. For more information, see Pager Control Styles.

Return Value

The state of the button specified by the iButton parameter. The state is either PGF_INVISIBLE, PGF_NORMAL, PGF_GRAYED, PGF_DEPRESSED, or PGF_HOT. For more information, see the Return Value section of the PGM_GETBUTTONSTATE message.

Remarks

This method sends the PGM_GETBUTTONSTATE message, which is described in the Windows SDK.

See Also

Reference

CPagerCtrl Class

Hierarchy Chart

PGM_GETBUTTONSTATE