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

int32_t pinnedShape_Attribute(int32_t shapeIndex, int32_t attributeIndex) const;

Parameters

shapeIndex The (zero-based) index of the shape being queried. Must be greater than or equal to zero, and less than the value returned by numberOfPinnedShapes().
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.

C# Mapping

int pinnedShape_Attribute(int shapeIndex, int attributeIndex);

Java Mapping

int pinnedShape_Attribute(int shapeIndex, int attributeIndex);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iAnchorsAndPinnedShapes::pinnedShape_Name()