Skip to content

Latest commit

 

History

History
147 lines (106 loc) · 5.31 KB

nf-xpsobjectmodel-ixpsomgeometryfigure-getsegmenttypes.md

File metadata and controls

147 lines (106 loc) · 5.31 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.GetSegmentTypes
IXpsOMGeometryFigure::GetSegmentTypes (xpsobjectmodel.h)
Gets the types of segments in the figure.
GetSegmentTypes
GetSegmentTypes method [XPS Documents and Packaging]
GetSegmentTypes method [XPS Documents and Packaging]
IXpsOMGeometryFigure interface
IXpsOMGeometryFigure interface [XPS Documents and Packaging]
GetSegmentTypes method
IXpsOMGeometryFigure.GetSegmentTypes
IXpsOMGeometryFigure::GetSegmentTypes
xps.ixpsomgeometryfigure_getsegmenttypes
xpsobjectmodel/IXpsOMGeometryFigure::GetSegmentTypes
xps\ixpsomgeometryfigure_getsegmenttypes.htm
xps
a440c227-33c9-42f9-8f4a-4cbe6281f9ad
12/05/2018
GetSegmentTypes, GetSegmentTypes method [XPS Documents and Packaging], GetSegmentTypes method [XPS Documents and Packaging],IXpsOMGeometryFigure interface, IXpsOMGeometryFigure interface [XPS Documents and Packaging],GetSegmentTypes method, IXpsOMGeometryFigure.GetSegmentTypes, IXpsOMGeometryFigure::GetSegmentTypes, xps.ixpsomgeometryfigure_getsegmenttypes, xpsobjectmodel/IXpsOMGeometryFigure::GetSegmentTypes
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::GetSegmentTypes
xpsobjectmodel/IXpsOMGeometryFigure::GetSegmentTypes
c++
APIRef
kbSyntax
COM
xpsobjectmodel.h
IXpsOMGeometryFigure.GetSegmentTypes

IXpsOMGeometryFigure::GetSegmentTypes

-description

Gets the types of segments in the figure.

-parameters

-param segmentCount [in, out]

The size of the array that is referenced by segmentTypes (see below). 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 segmentTypes.

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

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

-param segmentTypes [in, out]

An array of XPS_SEGMENT_TYPE values that has the same number of elements as specified in segmentCount. If the caller requires that only the specified buffer size be returned, set this value to NULL.

If the array is large enough, this method will copy the XPS_SEGMENT_TYPE values into the array and return, in segmentCount, the number of the copied values. If segmentTypes 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, which is specified as the number of elements.

-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
segmentTypes is NULL or references a buffer that is not large enough to receive the XPS_SEGMENT_TYPE data. segmentCount contains the required number of elements.

-remarks

For an example of how to use this method in a program, see the code example in GetSegmentData.

-see-also

GetSegmentCount

GetSegmentData

GetSegmentDataCount

IXpsOMGeometryFigure

XML Paper Specification

XPS Document Errors

XPS_SEGMENT_TYPE