The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IXpsOMGradientStop::GetOffset method

Gets the offset value of the gradient stop.

Syntax

C++


HRESULT GetOffset(
  [out, retval] FLOAT *offset
);

Parameters

offset [out, retval]: The offset value of the gradient stop, expressed as a fraction of the gradient path.

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	offset is NULL.

Remarks

The valid range of values returned in offset is 0.0–1.0. 0.0 is the start point of the gradient, 1.0 is the end point, and a value between 0.0 and 1.0 is a location that is linearly interpolated between the start point and the end point.

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Header	Xpsobjectmodel.h
IDL	XpsObjectModel.idl