IXpsOMGeometryFigure::GetIsClosed method (xpsobjectmodel.h)

Article
02/22/2024

Gets a value that indicates whether the figure is closed.

Syntax

HRESULT GetIsClosed(
  [out, retval] BOOL *isClosed
);

Parameters

[out, retval] isClosed

The Boolean value that indicates whether the figure is closed.

Value	Meaning
TRUE	The figure is closed. The line segment between the start and end points of the figure will be stroked to close the shape.
FALSE	The figure is open. No line segment will be stroked between the start and end points of the figure.

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

Remarks

This value only applies if the PathFigure attribute is used in the Path element that specifies a stroke.

A closed figure adds a line segment between the start point and the end point of the figure to close the shape.

This value corresponds to that of the IsClosed element of the PathFigure element in the document markup.

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