SBM_SETSCROLLINFO

  • Article

This message is sent by an application to set the parameters of a scroll bar.

SBM_SETSCROLLINFO wParam = (WPARAM) fRedraw; 
  lParam = (LPARAM) (LPSCROLLINFO) lpsi;

Parameters

  • fRedraw
    Boolean value that specifies whether the scroll bar is redrawn to reflect the new scroll box position. If set to TRUE, the scroll bar is redrawn. If set to FALSE, the scroll bar is not redrawn.

  • lpsi
    Long pointer to a SCROLLINFO structure. Before sending the message, set the cbSize member of the structure to sizeof(SCROLLINFO), set the fMask member to indicate the parameters to set, and specify the new parameter values in the appropriate members.

    The fMask member can be a combination of the following values.

    Value Description
    SIF_DISABLENOSCROLL Disables the scroll bar instead of removing it, if the scroll bar’s new parameters make the scroll bar unnecessary.
    SIF_PAGE Sets the scroll page to the value specified in the nPage member of the SCROLLINFO structure pointed to by lpsi.
    SIF_POS Sets the scroll position to the value specified in the nPos member of the SCROLLINFO structure pointed to by lpsi.
    SIF_RANGE Sets the scroll range to the value specified in the nMin and nMax members of the SCROLLINFO structure pointed to by lpsi.

Return Values

The current position of the scroll box indicates success.

Remarks

The messages that indicate scroll-bar position, WM_HSCROLL and WM_VSCROLL, provide only 16 bits of position data. However, the SCROLLINFO structure used by SBM_GETSCROLLINFO, SBM_SETSCROLLINFO, GetScrollInfo, and SetScrollInfo provides 32 bits of scroll-bar position data. You can use these messages and functions while processing either the WM_HSCROLL or WM_VSCROLL messages to obtain 32-bit scroll-bar position data.

In Windows CE 2.0, if you pass a null pointer in the lpsi parameter (lParam), SBM_SETSCROLLINFO returns zero, rather than the current position of the scroll box. For Windows CE 2.10 and later, the current position of the scroll box is returned.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Commctrl.h.

See Also

SBM_GETSCROLLINFO | SCROLLINFO | WM_HSCROLL | WM_VSCROLL

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.