FlatSB_SetScrollInfo function (commctrl.h)

Article
01/20/2022

Sets the information for a flat scroll bar. If flat scroll bars are not initialized for the window, this function calls the standard SetScrollInfo function.

Syntax

int FlatSB_SetScrollInfo(
  HWND         unnamedParam1,
  int          code,
  LPSCROLLINFO psi,
  BOOL         fRedraw
);

Parameters

unnamedParam1

Type: HWND

A handle to the window that contains the flat scroll bar. This window handle must have been passed previously in a call to InitializeFlatSB.

code

Type: int

The scroll bar type. It can be one of the following values:

Value	Meaning
SB_HORZ	Sets the information for the horizontal scroll bar.
SB_VERT	Sets the information for the vertical scroll bar.

psi

Type: LPSCROLLINFO

A pointer to a SCROLLINFO structure that contains the new information for the specified scroll bar. The cbSize and fMask members of the structure must be filled in prior to calling FlatSB_SetScrollInfo. The fMask member specifies which members of the structure contain valid information and can be any combination of the following values:

Value	Meaning
SIF_DISABLENOSCROLL	Disables the scroll bar if the new information would cause the scroll bar to be removed.
SIF_PAGE	Sets the page information for the flat scroll bar. The nPage member of the SCROLLINFO structure must contain the new page value.
SIF_POS	Sets the position information for the flat scroll bar. The nPos member of the SCROLLINFO structure must contain the new position value.
SIF_RANGE	Sets the range information for the flat scroll bar. The nMin and nMax members of the SCROLLINFO structure must contain the new range values.
SIF_ALL	A combination of SIF_PAGE, SIF_POS, and SIF_RANGE.

fRedraw

Type: BOOL

Specifies whether the scroll bar should be redrawn immediately to reflect the change. If this parameter is TRUE, the scroll bar is redrawn; if it is FALSE, the scroll bar is not redrawn.

Return value

Type: int

Returns the current scroll position. If the call to FlatSB_SetScrollInfo changes the scroll position, then the previous position is returned.

Remarks

Note Flat scroll bar functions are implemented in Comctl32.dll versions 4.71 through 5.82. Comctl32.dll versions 6.00 and higher do not support flat scroll bars.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h
Library	Comctl32.lib
DLL	Comctl32.dll (version 4.71 or later)

Share via