Sandcastle XML Comments Guide
Custom
This exception class is thrown by the application if it encounters an
unrecoverable error.
Definition
Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
C#
[SerializableAttribute]
public class CustomException : ExceptionVB
<SerializableAttribute>
Public Class CustomException
Inherits ExceptionC++
[SerializableAttribute]
public ref class CustomException : public ExceptionF#
[<SerializableAttribute>]
type CustomException =
class
inherit Exception
endConstructors
| CustomException | Default constructor. |
| CustomException(String) | Initializes a new instance of the Exception class with a specified error message. |
| CustomException(SerializationInfo, StreamingContext) | Initializes a new instance of the Exception class with serialized data. |
| CustomException(String, Exception) | Initializes a new instance of the Exception class with a specified error message and a reference to the inner exception that is the cause of this exception. |
Properties
| Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception) |
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception) |
| Message | Gets a message that describes the current exception. (Inherited from Exception) |
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception) |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception) |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetObjectData | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception) |
Events
| SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception) |