IXpsOMLinearGradientBrush::SetEndPoint method (xpsobjectmodel.h)

Article
02/22/2024

Sets the end point of the gradient.

Syntax

HRESULT SetEndPoint(
  [in] const XPS_POINT *endPoint
);

Parameters

[in] endPoint

The x and y coordinates of the end point.

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_INVALIDARG	The point described by endPoint was not valid. The XPS_POINT structure must contain valid and finite floating-point values.
E_POINTER	endPoint is NULL.

Remarks

The coordinates are relative to the page and are expressed in the units of the transform that is in effect.

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