GetSpareLoadValue Method


Gets the value of the apparent load parameter for a spare

Namespace: Autodesk.Revit.DB.Electrical
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2013

Syntax

C#
public double GetSpareLoadValue(
	int row,
	int column,
	ElementId idLoadParameter
)
Visual Basic
Public Function GetSpareLoadValue ( _
	row As Integer, _
	column As Integer, _
	idLoadParameter As ElementId _
) As Double
Visual C++
public:
double GetSpareLoadValue(
	int row, 
	int column, 
	ElementId^ idLoadParameter
)

Parameters

row
Type: SystemInt32
A row where the valid spare is
column
Type: SystemInt32
A column where the valid spare is
idLoadParameter
Type: Autodesk.Revit.DBElementId
One of 4 valid load parameters: RBS_ELEC_APPARENT_LOAD, RBS_ELEC_APPARENT_LOAD_PHASEA, RBS_ELEC_APPARENT_LOAD_PHASEB, RBS_ELEC_APPARENT_LOAD_PHASEC

Return Value

The value of the spare's load parameter

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException The load parameter id is not valid.
Autodesk.Revit.ExceptionsArgumentNullException A non-optional argument was null
Autodesk.Revit.ExceptionsArgumentsInconsistentException The row column combination does not represent a valid spare.

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →