Skip to content

Latest commit

 

History

History
152 lines (124 loc) · 4.86 KB

nf-xpsobjectmodel-ixpsomgeometryfigure-getsegmentstrokes.md

File metadata and controls

152 lines (124 loc) · 4.86 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xpsobjectmodel.IXpsOMGeometryFigure.GetSegmentStrokes
IXpsOMGeometryFigure::GetSegmentStrokes (xpsobjectmodel.h)
Gets stroke definitions for the figure's segments.
FALSE
GetSegmentStrokes
GetSegmentStrokes method [XPS Documents and Packaging]
GetSegmentStrokes method [XPS Documents and Packaging]
IXpsOMGeometryFigure interface
IXpsOMGeometryFigure interface [XPS Documents and Packaging]
GetSegmentStrokes method
IXpsOMGeometryFigure.GetSegmentStrokes
IXpsOMGeometryFigure::GetSegmentStrokes
TRUE
xps.ixpsomgeometryfigure_getsegmentstrokes
xpsobjectmodel/IXpsOMGeometryFigure::GetSegmentStrokes
xps\ixpsomgeometryfigure_getsegmentstrokes.htm
xps
97832bcb-c193-48e2-84f5-21b9c5a55cc9
12/05/2018
FALSE, GetSegmentStrokes, GetSegmentStrokes method [XPS Documents and Packaging], GetSegmentStrokes method [XPS Documents and Packaging],IXpsOMGeometryFigure interface, IXpsOMGeometryFigure interface [XPS Documents and Packaging],GetSegmentStrokes method, IXpsOMGeometryFigure.GetSegmentStrokes, IXpsOMGeometryFigure::GetSegmentStrokes, TRUE, xps.ixpsomgeometryfigure_getsegmentstrokes, xpsobjectmodel/IXpsOMGeometryFigure::GetSegmentStrokes
xpsobjectmodel.h
Windows
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
XpsObjectModel.idl
Windows
19H1
IXpsOMGeometryFigure::GetSegmentStrokes
xpsobjectmodel/IXpsOMGeometryFigure::GetSegmentStrokes
c++
APIRef
kbSyntax
COM
xpsobjectmodel.h
IXpsOMGeometryFigure.GetSegmentStrokes

IXpsOMGeometryFigure::GetSegmentStrokes

-description

Gets stroke definitions for the figure's segments.

-parameters

-param segmentCount [in, out]

The size of the array that is referenced by segmentStrokes. This parameter must not be NULL.

If the method returns successfully, segmentCount will contain the number of elements that are returned in the array referenced by segmentStrokes.

If segmentStrokes is NULL when the method is called, segmentCount must be set to zero.

If a NULL pointer is returned in segmentStrokes, the value of segmentCount will contain the required buffer size, specified as the number of elements.

-param segmentStrokes [in, out]

An array that has the same number of elements as specified in segmentCount. If the caller requires that this method return only the required buffer size, set this value to NULL.

If the array is large enough, this method copies the segment stroke values into the array and returns, in segmentCount, the number of copied segment stroke values. If segmentData is NULL or references a buffer that is not large enough, a NULL pointer will be returned, no data will be copied, and segmentCount will contain the required buffer size that is specified as the number of elements.

The following table shows the possible values of an element in the array that is referenced by segmentStrokes.

Value Meaning
TRUE
The segment is stroked.
FALSE
The segment is not stroked.

-returns

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Return code Description
S_OK
The method succeeded.
E_POINTER
segmentCount is NULL.
ERROR_MORE_DATA
segmentStrokes is NULL or references a buffer that is not large enough to receive the segment stroke data. segmentCount contains the required number of elements.

-see-also

IXpsOMGeometryFigure

XML Paper Specification