Namespace: Autodesk.Revit.DB.Structure Class: RebarFreeFormAccessor

RebarFreeFormAccessor.GetShapeIdAtIndex

Method

Description:
Gets the Rebar Shape id for the bar with index barPositionIndex.

Remarks:
If this function is called for a bar that isn't included, this function will throw exception.

Syntax

public ElementId GetShapeIdAtIndex(
	int barPositionIndex
)

Public Function GetShapeIdAtIndex ( 
	barPositionIndex As Integer
) As ElementId

public:
ElementId^ GetShapeIdAtIndex(
	int barPositionIndex
)

member GetShapeIdAtIndex : 
        barPositionIndex : int -> ElementId

Parameters

Parameter	Type	Description
barPositionIndex	Int32	An index between 0 and (NumberOfBarPositions-1).

Return Value

Type	Description
ElementId	Gets the ElementId of the Rebar Shape for the bar with index barPositionIndex.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	barPositionIndex is not in the range [ 0, NumberOfBarPositions-1 ]. -or- The bar at barPositionIndex index is excluded.