DOFException Class

OpenDOF Object Access Library

DOFException is the base class for all exceptions in the DOF and consists of an error code and error message.

Inheritance Hierarchy

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2

Syntax

[SerializableAttribute]
public class DOFException : Exception, 
	DOFImmutable

The DOFException type exposes the following members.

Constructors

	Name	Description
	DOFException	Construct a DOFException with error code FAILED .
	DOFException(Exception)	Construct a DOFException with error code FAILED and containing a cause.
	DOFException(Int32)	Construct a DOFException containing an error code.
	DOFException(String)	Construct a DOFException with error code FAILED and containing an error message.
	DOFException(Int32, DOFProviderInfo)	Construct a DOFException containing an error code and a DOFProviderInfo .
	DOFException(Int32, Exception)	Construct a DOFException containing an error code, and a cause.
	DOFException(Int32, String)	Construct a DOFException containing an error message and an error code.
	DOFException(String, Exception)	Construct a DOFException with error code FAILED and containing an error message and a cause.
	DOFException(Int32, String, DOFProviderInfo)	Construct a DOFException containing an error message and an error code, and a DOFProviderInfo .
	DOFException(Int32, String, Exception)	Construct a DOFException containing an error message, an error code, and a cause.
	DOFException(Int32, String, Exception, DOFProviderInfo)	Construct a DOFException containing an error message, an error code, and a DOFProviderInfo .

Properties

	Name	Description
	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 conditions of this exception. (Overrides ExceptionMessage.)
	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

	Name	Description
	create(Int32, String, Exception)	Create a DOFException using an error code, an error message, and a cause.
	create(Int32, String, Exception, DOFProviderInfo)	Create a DOFException using an error code, an error message, a cause, and a providerInfo.
	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.)
	getErrorCode	Get the error code for this exception.
	getErrorCodeString	Get a String representation of an error code.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjectData	When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
	getProviderInfo	Returns information about the provider that threw this exception, if any.
	GetType	Gets the runtime type of the current instance. (Inherited from Exception.)
	marshal	Write an object to a serialized form to the specified buffer, according to the context specified and with the given state.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Get a string representation of this object. (Overrides ExceptionToString.)

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)

Fields

	Name	Description
	errorCode	The error code.
	FAILED	General failure (no specific error code applies).

Remarks

DOFException is the base class for all exceptions in the DOF and consists of an error code and error message.