GetBarIndexFromReference Method
Given a reference that represents a part of a bar, this method will return the bar index.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since:  2022

Syntax

C#
public int GetBarIndexFromReference(
	Reference barReference
)
Visual Basic
Public Function GetBarIndexFromReference ( _
	barReference As Reference _
) As Integer
Visual C++
public:
int GetBarIndexFromReference(
	Reference^ barReference
)

Parameters

barReference
Type: Autodesk.Revit.DB..::..Reference
The Reference of the Rebar element.

Return Value

The bar index the reference refers to.

Remarks

The method returns an index between 0 and NumberOfBarPositions - 1 if it the given reference represents a part of a bar. Otherwise will return -1.

Exceptions

ExceptionCondition
Autodesk.Revit.Exceptions..::..ArgumentNullException A non-optional argument was null

See Also

M:Autodesk.Revit.DB.Structure.Rebar.GetBarIndexFromReference(Autodesk.Revit.DB.Reference)