Class: TDocumentException

Declaration: BasicDocumentException.h

Taxonomy Categories:

Member Functions:

TDocumentException
~TDocumentException
operator=
GetCause
operator>>=
operator<<=
Throw

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TDocumentException is used to transport information about exceptions raised by documents. This class allows exception handlers to distinguish between document exceptions and those of other subsystems via a catch block.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Developers who create derived classes of TDocument might also want to create a TDocumentException de rived class to add additional exception types.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentException::TDocumentException

TDocumentException (ECause)
TDocumentException (const TDocumentException &)
TDocumentException ()

Interface Category:

API.

Purpose:

Constructs a document exception specifying a specific cause.
Copy Constructor.
Default Constructor.

Calling Context:

Called when throwing an exception.
Called to copy an object.
Called by the stream-in operators. You can also call this function directly.

Parameters:

ECause theCause -The specific cause of the exception.
const TDocumentException & -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentException::~TDocumentException

~ TDocumentException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentException::operator=

TDocumentException & operator =(const TDocumentException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TDocumentException & -The object to be copied.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentException::GetCause

ECause GetCause () const

Interface Category:

API.

Purpose:

Provides access to specific exception information. The cause of the exception can be determined from the value returned

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

ECause theCause -The value indicating the cause of the exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentException::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentException::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws the exception.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws the exception represented by this object.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.