IXpsOMPath::SetStrokeMiterLimit method
Sets the miter limit of the path.
Syntax
HRESULT SetStrokeMiterLimit(
[in] FLOAT strokeMiterLimit
);
Parameters
- strokeMiterLimit [in]
The miter limit value to be set. The value must be 1.0 or greater.
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 | A value that was passed in strokeMiterLimit was not valid. |
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
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 |