PathEngine home previous: iAnchorsAndPinnedShapes::pinnedShape_AnchorIndex()next: iAnchorsAndPinnedShapes::pinnedShape_Name()
Contents, API Reference, Interfaces, iAnchorsAndPinnedShapes, pinnedShape_Attribute

iAnchorsAndPinnedShapes::pinnedShape_Attribute()

Description

Used to query attributes of the specified shape in an extensible manner.

Syntax

tSigned32 pinnedShape_Attribute(tSigned32 shapeIndex, tSigned32 attributeIndex) const;

Parameters

shapeIndex The (zero-based) index of the shape being queried.
attributeIndex An index to specify the attribute being queried.
See Pinned Shape Attributes for a list of values that can be specified for this parameter.

Return value

-1 indicates that the value of the queried attribute is undefined.
Otherwise the value of the queried attribute is returned.

For boolean attributes 0 is used to indicate false, and 1 to indicate true.

Documentation for PathEngine release 5.18 - Copyright © 2002-2008 PathEnginenext: iAnchorsAndPinnedShapes::pinnedShape_Name()