IXpsOMPath::GetStrokeMiterLimit method (xpsobjectmodel.h)

Article
02/22/2024

Gets the miter limit value that is set for the stroke.

Syntax

HRESULT GetStrokeMiterLimit(
  [out, retval] FLOAT *strokeMiterLimit
);

Parameters

[out, retval] strokeMiterLimit

The miter limit value that is set for the stroke.

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

Remarks

The miter limit value is the ratio of the maximum miter length to one-half of the stroke thickness.

The miter limit value describes how to render a mitered line join; this value applies only if the line join style value is XPS_LINE_JOIN_MITER.

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