RebarCoupler.Create
Method
Description:
Creates a new instance of a Rebar Coupler element within the project.
Creates a new instance of a Rebar Coupler element within the project.
Syntax
public static RebarCoupler Create(
Document doc,
ElementId typeId,
ReinforcementData pFirstData,
ReinforcementData pSecondData,
out RebarCouplerError error
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| doc | Document | A document. |
| typeId | ElementId | type id for coupler |
| pFirstData | ReinforcementData | information about the first reinforcement to be coupled |
| pSecondData | ReinforcementData | information about the second reinforcement to be coupled; if a nullptr is passed in the coupler is placed on one reinforcement |
| error | RebarCouplerError | will be ValidationSuccesfully(0) if ok, otherwise the failure reason |
Return Value
| Type | Description |
|---|---|
| RebarCoupler | The newly created Rebar Coupler instance, or if the operation fails. |
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | A non-optional argument was null |
| ArgumentOutOfRangeException | A value passed for an enumeration argument is not a member of that enumeration |