IASProgressBar::get_RangeColor

This method gets the color assigned to a range.

Syntax

HRESULT get_RangeColor( long lRangeIndex, OLE_COLOR *pclr );

Parameters

lRangeIndex
Long integer that indicates the index of the desired range.
pclr
Pointer to the range color.

Return Values

NOERROR indicates success. E_INVALIDARG indicates that an invalid argument has been entered.

Remarks

Progress bars can be broken into two or more ranges, each of a different color. For example, if a progress bar can take a value between 0 and 10 and is divided into three ranges: red, green, and blue, then the RangeCount property is 3, and the related properties are listed in the following table.

Index
Color
RangeValue
Range
0 Red 0 0 - 3
1 Green 4 4 - 7
2 Blue 8 8-10

Use the GetRValue, GetGValue, and GetBValue macros to get the color components of pclr.

See Also

IASProgressBar, IASProgressBar::put_RangeColor, IASProgressBar::get_RangeValue, GetRValue, GetGValue, GetBValue