CWnd::SetScrollPos

Sets the current position of a scroll box and, if requested, redraws the scroll bar to reflect the new position of the scroll box.

int SetScrollPos( 
   int nBar, 
   int nPos, 
   BOOL bRedraw = TRUE  
);

Parameters

  • nBar
    Specifies the scroll bar to be set. This parameter can be either of the following:

    • SB_HORZ   Sets the position of the scroll box in the horizontal scroll bar of the window.

    • SB_VERT   Sets the position of the scroll box in the vertical scroll bar of the window.

  • nPos
    Specifies the new position of the scroll box. It must be within the scrolling range.

  • bRedraw
    Specifies whether the scroll bar should be repainted to reflect the new scroll-box position. If this parameter is TRUE, the scroll bar is repainted; if FALSE, the scroll bar is not repainted.

Return Value

The previous position of the scroll box.

Remarks

Setting bRedraw to FALSE is useful whenever the scroll bar will be redrawn by a subsequent call to another function.

Requirements

Header: afxwin.h

See Also

Reference

CWnd Class

Hierarchy Chart

SetScrollPos

CWnd::GetScrollPos

CScrollBar::SetScrollPos