LinearGradientBrush::GetLinearColors method (gdiplusbrush.h)

The LinearGradientBrush::GetLinearColors method gets the starting color and ending color of this linear gradient brush.

Syntax

Status GetLinearColors(
  [out] Color *colors
);

Parameters

[out] colors

Type: Color*

Pointer to an array that receives the starting color and the ending color. The first color in the colors array is the color at the starting boundary line of the gradient; the second color in the colors array is the color at the ending boundary line.

Return value

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Requirements

Requirement	Value
Minimum supported client	Windows XP, Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	gdiplusbrush.h (include Gdiplus.h)
Library	Gdiplus.lib
DLL	Gdiplus.dll

See also

Brushes and Filled Shapes

Color

Creating a Linear Gradient

Filling a Shape with a Color Gradient

LinearGradientBrush

LinearGradientBrush::SetLinearColors

Rect

SolidBrush