Class: TArchiveAccessError

Declaration: ArchiveExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TArchiveException

Inherited By:

None.

Purpose:

Objects of this class are thrown when an archive access error occurs. There are currently two reasons why an archive access error might occur. First, it may not be possible to gain read access to an archive and second, it may not be possible to gain write access to an archive.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly. Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TArchiveAccessError::TArchiveAccessError

TArchiveAccessError (EReason reason)
TArchiveAccessError (const TArchiveAccessError & copy)
TArchiveAccessError ()

Interface Category:

API.

Purpose:

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

Calling Context:

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

Parameters:

EReason reason -The reason this exception was thrown.
const TArchiveAccessError & copy -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArchiveAccessError::~TArchiveAccessError

virtual ~ TArchiveAccessError ()

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: TArchiveAccessError::operator=

TArchiveAccessError & operator =(const TArchiveAccessError & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TArchiveAccessError & 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.

Member Function: TArchiveAccessError::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Return the reason this exception was thrown.

Calling Context:

Called by clients.

Parameters:

Takes no parameters.

Return Value:

The reason the exception was thrown.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArchiveAccessError::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Polymorphic throw operation.

Calling Context:

Called by clients.

Parameters:

Takes no parameters.

Return Value:

None.

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.