IXpsOMPath::GetStrokeDashCap method (xpsobjectmodel.h)

Article
10/13/2021

Gets the style of the end cap to be used on the stroke dash.

Syntax

HRESULT GetStrokeDashCap(
  [out, retval] XPS_DASH_CAP *strokeDashCap
);

Parameters

[out, retval] strokeDashCap

The XPS_DASH_CAP value that describes the style of the end cap to be used on the stroke dash.

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

Remarks

For more information about dash cap styles, see XPS_DASH_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