windows_programming_notes.nbk: Home | Index | Next Page: SelectObject | Previous Page: Scroll Bar Controls in Win32

 SCROLLINFO

The SCROLLINFO structure contains scroll bar parameters to be set by the SetScrollInfo function (or SBM_SETSCROLLINFO message), or retrieved by the GetScrollInfo function (or SBM_GETSCROLLINFO message).

Syntax

    typedef struct tagSCROLLINFO { 
        UINT cbSize; 
        UINT fMask; 
        int  nMin; 
        int  nMax; 
        UINT nPage; 
        int  nPos; 
        int  nTrackPos; 
    }   SCROLLINFO, *LPSCROLLINFO; 
    typedef SCROLLINFO CONST *LPCSCROLLINFO;

Members

• cbSize
  Specifies the size, in bytes, of this structure. The caller must set this to sizeof(SCROLLINFO).
• fMask
  Specifies the scroll bar parameters to set or retrieve. This member can be a combination of the following values:
  • SIF_ALL
    Combination of SIF_PAGE, SIF_POS, SIF_RANGE, and SIF_TRACKPOS.
  • SIF_DISABLENOSCROLL
    This value is used only when setting a scroll bar's parameters. If the scroll bar's new parameters make the scroll bar unnecessary, disable the scroll bar instead of removing it.
  • SIF_PAGE
    The nPage member contains the page size for a proportional scroll bar.
  • SIF_POS
    The nPos member contains the scroll box position, which is not updated while the user drags the scroll box.
  • SIF_RANGE
    The nMin and nMax members contain the minimum and maximum values for the scrolling range.
  • SIF_TRACKPOS
    The nTrackPos member contains the current position of the scroll box while the user is dragging it.
• nMin
  Specifies the minimum scrolling position.
• nMax
  Specifies the maximum scrolling position.
• nPage
  Specifies the page size. A scroll bar uses this value to determine the appropriate size of the proportional scroll box.
• nPos
  Specifies the position of the scroll box.
• nTrackPos
  Specifies the immediate position of a scroll box that the user is dragging. An application can retrieve this value while processing the SB_THUMBTRACK request code. An application cannot set the immediate scroll position; the SetScrollInfo function ignores this member.

Structure Information

• Header Declared in Winuser.h, include Windows.h
• Minimum operating systems Windows 95, Windows NT 3.51

windows_programming_notes.nbk: Home | Index | Next Page: SelectObject | Previous Page: Scroll Bar Controls in Win32

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time