BuilderException Class

This exception class is thrown by the application if it encounters an unrecoverable error

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0

C#View Source Request Example

[SerializableAttribute]
public class BuilderException : Exception

VBView Source Request Example

<SerializableAttribute>
Public Class BuilderException
	Inherits Exception

C++View Source Request Example

[SerializableAttribute]
public ref class BuilderException : public Exception

F#View Source Request Example

[<SerializableAttribute>]
type BuilderException = 
    class
        inherit Exception
    end

Inheritance: Object Exception BuilderException

Constructors

BuilderException	Default constructor.
BuilderException(String)	Initializes a new instance of the Exception class with a specified error message.
BuilderException(SerializationInfo, StreamingContext)	Deserialization constructor for use with ISerializable
BuilderException(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.
BuilderException(String, String)	This constructor takes an error code and a message string
BuilderException(String, String, Exception)	This constructor takes an error code, a message string, and an inner exception

Properties

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
ErrorCode	Get the error code associated with the 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	This implements the ISerializable interface and adds the error code to the serialization information. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext))
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)

Extension Methods

GetExceptionMessage

This is used to get the message strings from an exception and any of its inner exceptions
(Defined by BuildComponentUtilities)