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

RebarSpliceUtils.GetSpliceGeometries

Method

Description:
Computes a list of RebarSpliceGeometry which respects the rules. This list can be used to splice the Rebar.

Syntax

public static RebarSpliceByRulesResult GetSpliceGeometries(
	Document document,
	ElementId rebarIdToSplit,
	RebarSpliceOptions spliceOptions,
	RebarSpliceRules spliceRules
)

Public Shared Function GetSpliceGeometries ( 
	document As Document,
	rebarIdToSplit As ElementId,
	spliceOptions As RebarSpliceOptions,
	spliceRules As RebarSpliceRules
) As RebarSpliceByRulesResult

public:
static RebarSpliceByRulesResult^ GetSpliceGeometries(
	Document^ document, 
	ElementId^ rebarIdToSplit, 
	RebarSpliceOptions^ spliceOptions, 
	RebarSpliceRules^ spliceRules
)

static member GetSpliceGeometries : 
        document : Document * 
        rebarIdToSplit : ElementId * 
        spliceOptions : RebarSpliceOptions * 
        spliceRules : RebarSpliceRules -> RebarSpliceByRulesResult

Parameters

Parameter	Type	Description
document	Document	The document
rebarIdToSplit	ElementId	Rebar id to split.
spliceOptions	RebarSpliceOptions	The rebar splice options.
spliceRules	RebarSpliceRules	The splice rules.

Return Value

Type	Description
RebarSpliceByRulesResult	Returns the result of the operation. If the operation was successful the RebarSpliceByRulesResult.Error member will have "RebarSpliceByRulesError.Success" value.

Exceptions

Exception	Condition
ArgumentException	RebarSplicePosition should be Middle.
ArgumentNullException	A non-optional argument was null