M

RebarCoupler.Create

Description:
Creates a new instance of a Rebar Coupler element within the project.

public static RebarCoupler Create(
	Document doc,
	ElementId typeId,
	ReinforcementData pFirstData,
	ReinforcementData pSecondData,
	out RebarCouplerError error
)

Public Shared Function Create ( 
	doc As Document,
	typeId As ElementId,
	pFirstData As ReinforcementData,
	pSecondData As ReinforcementData,
	<OutAttribute> ByRef error As RebarCouplerError
) As RebarCoupler

public:
static RebarCoupler^ Create(
	Document^ doc, 
	ElementId^ typeId, 
	ReinforcementData^ pFirstData, 
	ReinforcementData^ pSecondData, 
	[OutAttribute] RebarCouplerError% error
)

static member Create : 
        doc : Document * 
        typeId : ElementId * 
        pFirstData : ReinforcementData * 
        pSecondData : ReinforcementData * 
        error : RebarCouplerError byref -> RebarCoupler

Document

doc

A document.
ElementId

typeId

type id for coupler
ReinforcementData

pFirstData

information about the first reinforcement to be coupled
ReinforcementData

pSecondData

information about the second reinforcement to be coupled; if a nullptr is passed in the coupler is placed on one reinforcement
RebarCouplerError%

error

will be ValidationSuccesfully(0) if ok, otherwise the failure reason

Return Value RebarCoupler The newly created Rebar Coupler instance, or if the operation fails.

ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration