FailureMessageKey
A unique key assigned to each posted failure message
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.FailureMessageKey
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class FailureMessageKey : IDisposableThe FailureMessageKey type exposes the following members.
Constructors
Name
Description
Public Method
FailureMessageKey
Constructs a new FailureMessageKey with default settings.
Properties
Name
Description
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
Methods
Name
Description
Public Method
Dispose
Releases all resources used by the FailureMessageKey
Public Method
Equals
Determines whether the specified Object is equal to the current Object.
(Overrides Object.Equals(Object))
Public Method
GetHashCode
Gets the integer value of the id as hash code
(Overrides Object.GetHashCode.)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
IsEqual
Checks it this key is equal to the other.
Public Method
IsValid
Checks if the failure message key is valid
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)
Operators
Name
Description
Public Operator
Static Member
Equality(FailureMessageKey, FailureMessageKey)
Determines whether two FailureMessageKeys are the same.
Public Operator
Static Member
Inequality(FailureMessageKey, FailureMessageKey)
Determines whether two FailureMessageKeys are different.
Remarks
When a failure message is posted, it gets a unique key assigned and returned to the caller. The key is guaranteed to be unique in the Revit session. The key can be used to unpost (delete) previously posted failure message if it is no longer valid.