•  

SetFailingElements Method

Sets elements that have caused the failure.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2011

Syntax

C#
public FailureMessage SetFailingElements(
	ICollection<ElementId> idsToShow
)
Visual Basic
Public Function SetFailingElements ( _
	idsToShow As ICollection(Of ElementId) _
) As FailureMessage
Visual C++
public:
FailureMessage^ SetFailingElements(
	ICollection<ElementId^>^ idsToShow
)

Parameters

idsToShow
Type: System.Collections.GenericICollectionElementId
The elements that have caused the failure.

Return Value

The FailureMessage.

Remarks

In the Revit error dialog these elements will be highlighted to the user and can be deleted by user via extended error dialog.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentNullException A non-optional argument was null
Autodesk.Revit.ExceptionsInvalidOperationException This FailureMessage is already posted to a document

See Also