IXpsOMGradientStop::GetColor method (xpsobjectmodel.h)

Article
02/22/2024

Gets the color value and color profile of the gradient stop.

Syntax

HRESULT GetColor(
  [out]         XPS_COLOR                  *color,
  [out, retval] IXpsOMColorProfileResource **colorProfile
);

Parameters

[out] color

The color value of the gradient stop.

[out, retval] colorProfile

A pointer to the IXpsOMColorProfileResource interface that contains the color profile to be used. If no color profile resource has been set, a NULL pointer is returned. See remarks.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	color, colorProfile, or both were NULL.

Remarks

A color profile is only returned when the color type of color is XPS_COLOR_TYPE_CONTEXT.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h