Share via


IXpsOMPath::GetStrokeThickness method

Gets the stroke thickness.

Syntax

HRESULT GetStrokeThickness(
  [out, retval] FLOAT *strokeThickness
);

Parameters

  • strokeThickness [out, retval]
    The stroke thickness value.

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

The value returned in strokeThickness specifies the thickness of a stroke in units of the effective coordinate space. The units include the path's render transform.

The stroke is drawn on top of the boundary of the path's geometry, such that one half of the stroke's width extends outside of the path's specified geometry and the other half falls inside of it.

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

See also

IXpsOMPath

XPS Document Errors

XML Paper Specification