IXpsOMPath::GetStrokeStartLineCap method (xpsobjectmodel.h)

Article
02/22/2024

Gets the style of the line cap at the start of the stroke line.

Syntax

HRESULT GetStrokeStartLineCap(
  [out, retval] XPS_LINE_CAP *strokeStartLineCap
);

Parameters

[out, retval] strokeStartLineCap

The XPS_LINE_CAP value that indicates the style of the line cap at the start of the stroke line.

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

Remarks

For more information about the shapes of line caps, see XPS_LINE_CAP.

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