StructuralFramingUtils.SetEndReference
Method
Description:
Sets the end reference of a framing element.
Sets the end reference of a framing element.
Remarks:
The setback value will be changed as a result of the removal.
The setback value will be changed as a result of the removal.
Parameters
Parameter | Type | Description |
---|---|---|
familyInstance | FamilyInstance | The FamilyInstance, which must be of a structural framing category, non-concrete and joined. |
end | Int32 | The index of the end (0 for the start, 1 for the end). |
pick | Reference | The reference to set to the given end. |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |
ArgumentOutOfRangeException | end must be 0 or 1. |
ArgumentsInconsistentException | The input familyInstance is not of a structural framing category or is concrete or is not joined at given end and cannot have an end reference set. -or- The input pick cannot be set as the end reference for the given end of the structural framing element. |