FlatSB_GetScrollInfo function (commctrl.h)

Article
01/20/2022

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

Syntax

BOOL FlatSB_GetScrollInfo(
  HWND         unnamedParam1,
  int          code,
  LPSCROLLINFO unnamedParam3
);

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

A parameter that specifies the scroll bar type. It can be one of the following values:

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

unnamedParam3

Type: LPSCROLLINFO

A pointer to a SCROLLINFO structure that will receive the information for the specified scroll bar. The cbSize and fMask members of the structure must be filled out prior to calling FlatSB_GetScrollInfo. The fMask member specifies which properties should be retrieved and can be any combination of the following values:

Value	Meaning
SIF_PAGE	Retrieves the page information for the flat scroll bar. This will be placed in the nPage member of the SCROLLINFO structure.
SIF_POS	Retrieves the position information for the flat scroll bar. This will be placed in the nPos member of the SCROLLINFO structure.
SIF_RANGE	Retrieves the range information for the flat scroll bar. This will be placed in the nMin and nMax members of the SCROLLINFO structure.
SIF_ALL	A combination of SIF_PAGE, SIF_POS, and SIF_RANGE.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

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