SetScrollInfo

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function sets the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb). SetScrollInfoalso redraws the scroll bar, if requested.

int
SetScrollInfo(
HWND
hwnd
,
int
fnBar
,
LPSCROLLINFO
lpsi
,
BOOL
fRedraw
);

Parameters

hwnd

Handle to a scroll bar control or a window with a standard scroll bar, depending on the value of the fnBarparameter.

fnBar

Specifies the type of scroll bar for which to set parameters. It is one of the following values:

Value	Description
SB_CTL	Sets the parameters of a scroll bar control. The hwndparameter must be the handle to the scroll bar control.
SB_HORZ	Sets the parameters of the given window's standard horizontal scroll bar.
SB_VERT	Sets the parameters of the given window's standard vertical scroll bar.

lpsi

Long pointer to a SCROLLINFOstructure. Before calling SetScrollInfo, set the cbSizemember of the structure to sizeof( SCROLLINFO), set the fMaskmember to indicate the parameters to set, and specify the new parameter values in the appropriate members.

The fMaskmember 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 nPagemember of the SCROLLINFOstructure pointed to by lpsi.
SIF_POS	Sets the scroll position to the value specified in the nPosmember of the SCROLLINFOstructure pointed to by lpsi.
SIF_RANGE	Sets the scroll range to the value specified in the nMinand nMaxmembers of the SCROLLINFOstructure pointed to by lpsi.

fRedraw

Boolean that specifies whether the scroll bar is redrawn to reflect the changes to the scroll bar. If this parameter is TRUE, the scroll bar is redrawn, otherwise, it is not redrawn.

Return Values

The current position of the scroll box indicates success.

Remarks

The SetScrollInfofunction performs range checking on the values specified by the nPageand nPosmembers of the SCROLLINFOstructure. The nPagemember must specify a value from 0 to nMax- nMin+1. The nPosmember must specify a value between nMinand nMax- max( nPage–1, 0). If either value is beyond its range, the function sets it to a value that is just within the range.

In Windows CE versions 2.0 and 2.01, if you pass a null pointer in the lpsiparameter, SetScrollInforeturns zero, rather than the current position of the scroll box. For Windows CE versions 2.10 and later, if you pass a null pointer in the lpsiparameter, SetScrollInforeturns the current scroll bar position and sets the ERROR_INVALID_PARAMETER error code through a call to SetLastError.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winuser.h		Sbcmn.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetScrollInfo, SCROLLINFO, SetLastError