FlatSB_GetScrollPropPtr function (commctrl.h)

Article
01/20/2022

Gets the properties for a flat scroll bar. This function can also be used to determine if InitializeFlatSB has been called for this window.

Note This is identical to FlatSB_GetScrollProp.

Syntax

BOOL FlatSB_GetScrollPropPtr(
  HWND     unnamedParam1,
  int      propIndex,
  PINT_PTR 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.

propIndex

Type: UINT

The parameter that determines what pValue represents and which property is being retrieved. It can be one of the following values.

Value	Meaning
WSB_PROP_CXHSCROLL	pValue is a pointer to an INT value that receives the width, in pixels, of the direction buttons in a horizontal scroll bar.
WSB_PROP_CXHTHUMB	pValue is a pointer to an INT value that receives the width, in pixels, of the thumb in a horizontal scroll bar.
WSB_PROP_CXVSCROLL	pValue a pointer to an INT value that receives the width, in pixels, of a vertical scroll bar.
WSB_PROP_CYHSCROLL	pValue is a pointer to an INT value that receives the height, in pixels, of a horizontal scroll bar.
WSB_PROP_CYVSCROLL	pValue is a pointer to an INT value that receives the height, in pixels, of the direction buttons in a vertical scroll bar.
WSB_PROP_CYVTHUMB	pValue is a pointer to an INT value that receives the height, in pixels, of the thumb in a vertical scroll bar.
WSB_PROP_HBKGCOLOR	pValue is a pointer to a COLORREF value that receives the background color in a horizontal scroll bar.
WSB_PROP_HSTYLE	pValue is a pointer to an INT value that receives one of the following visual effects for the horizontal scroll bar. FSB_ENCARTA_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar is displayed in 3-D. FSB_FLAT_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar is displayed in inverted colors. FSB_REGULAR_MODE A normal, nonflat scroll bar is displayed. No special visual effects are applied.
WSB_PROP_PALETTE	pValue is a pointer to an HPALETTE value that receives the palette that a scroll bar uses when drawing.
WSB_PROP_VBKGCOLOR	pValue is a pointer to a COLORREF value that receives the background color in a vertical scroll bar.
WSB_PROP_VSTYLE	pValue is a pointer to an INT value that receives one of the following visual effects for the vertical scroll bar. FSB_ENCARTA_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar is displayed in 3-D. FSB_FLAT_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar is displayed in inverted colors. FSB_REGULAR_MODE A normal, nonflat scroll bar is displayed. No special visual effects are applied.
WSB_PROP_WINSTYLE	pValue is a pointer to an INT value that receives the WS_HSCROLL and WS_VSCROLL style bits contained by the current window.

unnamedParam3

Type: LPINT

A pointer to an int that receives the requested data. This parameter depends on the flag passed in index.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise. If index is WSB_PROP_HSTYLE, the return is nonzero if InitializeFlatSB has been called for this window, 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