Click or drag to resize

CodedExceptionAttribute Class

[This is preliminary documentation and is subject to change.]

When applied to a class that inherits from Exception, specifies that the HResult property contains a custom error code.
Inheritance Hierarchy
SystemObject
  SystemAttribute
    NerdyDuck.CodedExceptionsCodedExceptionAttribute

Namespace:  NerdyDuck.CodedExceptions
Assembly:  NerdyDuck.CodedExceptions (in NerdyDuck.CodedExceptions.dll) Version: 2.0.0+2040dad
Syntax
Copy
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false)]
[ComVisibleAttribute(false)]
public sealed class CodedExceptionAttribute : Attribute
View Source

The CodedExceptionAttribute type exposes the following members.

Constructors
  NameDescription
Public methodCodedExceptionAttribute
Initializes a new instance of the CodedExceptionAttribute class.
Top
Properties
  NameDescription
Public propertyTypeId
When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute.)
Top
Methods
  NameDescription
Public methodEquals
Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute.)
Public methodGetHashCode
Returns the hash code for this instance.
(Inherited from Attribute.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIsCodedException
Checks if the type of the specified instance of Exception or a derived class is decorated with a CodedExceptionAttribute.
Public methodIsDefaultAttribute
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute.)
Public methodMatch
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate method_AttributeGetIDsOfNames
Maps a set of names to a corresponding set of dispatch identifiers.
(Inherited from Attribute.)
Explicit interface implementationPrivate method_AttributeGetTypeInfo
Retrieves the type information for an object, which can be used to get the type information for an interface.
(Inherited from Attribute.)
Explicit interface implementationPrivate method_AttributeGetTypeInfoCount
Retrieves the number of type information interfaces that an object provides (either 0 or 1).
(Inherited from Attribute.)
Explicit interface implementationPrivate method_AttributeInvoke
Provides access to properties and methods exposed by an object.
(Inherited from Attribute.)
Top
Remarks
When creating a new exception that can contain custom HResult values, decorate the class with the CodedExceptionAttribute, so that other code knows that the HResult property contains a meaningful coded numerical value that identifies an application-specific exception.
Examples
Using the attribute
Copy
using NerdyDuck.CodedExceptions;

[CodedException]
public class MyException : System.Exception
{
    ...
}
See Also