LinearGradientBrush::SetLinearColors method

The LinearGradientBrush::SetLinearColors method sets the starting color and ending color of this linear gradient brush.

Syntax

Status SetLinearColors(
  IN const Color & color1,
  IN const Color & color2
);

Parameters

color1

Type: const Color&

Reference to a Color object that specifies the color at the starting boundary line of this linear gradient brush.

color2

Type: const Color&

Reference to a Color object that specifies the color at the ending boundary line of this linear gradient brush.

Return Value

Type: 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

   
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::GetLinearColors

LinearGradientBrush::SetInterpolationColors

Rect