StructuralFramingUtils.IsJoinAllowedAtEnd Method

StructuralFramingUtilsIsJoinAllowedAtEnd Method

Identifies if the indicated end of the framing element is allowed to join to others.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.0.4.0 (26.0.4.0)
Syntax
public static bool IsJoinAllowedAtEnd(
	FamilyInstance familyInstance,
	int end
)
Public Shared Function IsJoinAllowedAtEnd ( 
	familyInstance As FamilyInstance,
	end As Integer
) As Boolean
public:
static bool IsJoinAllowedAtEnd(
	FamilyInstance^ familyInstance, 
	int end
)
static member IsJoinAllowedAtEnd : 
        familyInstance : FamilyInstance * 
        end : int -> bool

Parameters

familyInstance  FamilyInstance
The FamilyInstance, which must be of a structural framing category.
end  Int32
The index of the end (0 for the start, 1 for the end).

Return Value

Boolean
True if it is allowed to join. False if it is disallowed.
Exceptions
ExceptionCondition
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.
See Also

M:Autodesk.Revit.DB.Structure.StructuralFramingUtils.IsJoinAllowedAtEnd(Autodesk.Revit.DB.FamilyInstance,System.Int32)