M

RebarSpliceUtils.GetSpliceGeometries

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

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

Document

document

The document
ElementId

rebarIdToSplit

Rebar id to split.
RebarSpliceOptions

spliceOptions

The rebar splice options.
RebarSpliceRules

spliceRules

The splice rules.

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

ArgumentException

RebarSplicePosition should be Middle.
ArgumentNullException

A non-optional argument was null