Class: TArchiveException

Declaration: ArchiveExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

TArchiveAccessError TArchiveAlreadyExists TArchiveNotFound TArchivedObjectNotFound

Purpose:

TArchiveException is an abstract base class for archive exceptions. All exceptions originating in the TArchive, TArchiveKey, TArchiveEnvelope, TArchiveIterator or TArchiveLocaleIterator classes are derived from this class. Note that these classes may also pass through other exceptions not derived from TArchiveException. TArchiveException is a derived class of TStandardException. It does not implement any protocol beyond that supplied by TStandardException. It simply provides a convenient way to catch all exceptions generated by the archive classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class must be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TArchiveException::~TArchiveException

virtual ~ TArchiveException ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TArchiveException::TArchiveException

TArchiveException ()
TArchiveException (unsigned long reason)
TArchiveException (const TArchiveException & copy)

Interface Category:

API.

Purpose:

Default constructor. Creates an uninitialized object.
Create a TArchiveException with the given reason.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called by clients.
Called to copy an object.

Parameters:

Takes no parameters.
unsigned long reason -The reason this exception was thrown.
const TArchiveException & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArchiveException::operator=

TArchiveException & operator =(const TArchiveException & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TArchiveException & copy -The right hand side object.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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