RVTDocs.com
Namespace: Autodesk.Revit.DB

FailureMessage

Class
Description:
Represents a message describing a failure of an operation in Revit.
Remarks:
Failure messages are typically shown to the user in the Revit error dialog. This class contains the following information about the failures:
  1. The basic description of the failure (retrieved from the FailureDefinition)
  2. The available resolutions for the failure.
  3. The elements related to the failure.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.FailureMessage
Syntax
public class FailureMessage : IDisposable
FailureMessage Class Members:
Name Description Inherited From
FailureMessage Creates a new FailureMessage related to a given FailureDefinition.
Name Description Inherited From
IsValidObject Specifies whether the .NET object represents a valid Revit entity.
Name Description Inherited From
AddResolution Adds a resolution for the failure.
Dispose Releases all resources used by the FailureMessage
Equals Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
GetAdditionalElements Retrieves list of the additional reference elements for the failure.
GetDefaultResolutionCaption Retrieves the caption of the default resolution of the failure.
GetDescriptionText Retrieves the description text of the failure.
GetFailingElements Retrieves list of the elements that have caused the failure.
GetFailureDefinitionId Retrieves the id of the failure definition for the failure.
GetHashCode Serves as the default hash function. (Inherited from Object ) Object
GetSeverity Retrieves the severity of the failure.
GetType Gets the Type of the current instance. (Inherited from Object ) Object
HasResolutionOfType Checks if failure has a resolution of a given type.
HasResolutions Checks if the failure has any resolutions.
SetAdditionalElement Sets the additional reference element for the failure.
SetAdditionalElements Sets the additional reference elements for the failure.
SetFailingElement Sets the element that has caused the failure.
SetFailingElements Sets elements that have caused the failure.
ToString Returns a string that represents the current object. (Inherited from Object ) Object