FailureMessage.SetAdditionalElement

Public Class

Sets the additional reference element for the failure.

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public FailureMessage SetAdditionalElement(
  ElementId additionalElement
)

Parameters

additionalElement ElementId

The additional element.

Return Value

FailureMessage
The FailureMessage.

Exceptions

Exception

Condition

---

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.