RebarFreeFormAccessor.GetShapeIdAtIndex Method

RebarFreeFormAccessorGetShapeIdAtIndex Method

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

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
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

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

Return Value

ElementId
Gets the ElementId of the Rebar Shape for the bar with index barPositionIndex.
Exceptions
ExceptionCondition
ArgumentOutOfRangeException barPositionIndex is not in the range [ 0, NumberOfBarPositions-1 ]. -or- The bar at barPositionIndex index is excluded.
Remarks
If this function is called for a bar that isn't included, this function will throw exception.
See Also

M:Autodesk.Revit.DB.Structure.RebarFreeFormAccessor.GetShapeIdAtIndex(System.Int32)