FailureMessage.SetAdditionalElement Method

FailureMessageSetAdditionalElement Method

Sets the additional reference element for the failure.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.0.4.0 (26.0.4.0)
Syntax
public FailureMessage SetAdditionalElement(
	ElementId additionalElement
)
Public Function SetAdditionalElement ( 
	additionalElement As ElementId
) As FailureMessage
public:
FailureMessage^ SetAdditionalElement(
	ElementId^ additionalElement
)
member SetAdditionalElement : 
        additionalElement : ElementId -> FailureMessage 

Parameters

additionalElement  ElementId
The additional element.

Return Value

FailureMessage
The FailureMessage.
Exceptions
ExceptionCondition
ArgumentNullException A non-optional argument was null
InvalidOperationException This FailureMessage is already posted to a document
Remarks
Additional elements are used to highlight additional information to the user. They are not considered as causing the failure, but are related to it. User cannot delete them in extended error dialog.
See Also