Class: TCollectionException

Declaration: CollectionException.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TCollectionException is a class that is thrown to indicate exception conditions that occur while using collection classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not intended to be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TCollectionException::TCollectionException

TCollectionException ()
TCollectionException (ECollectionsExceptionID id)
TCollectionException (const TCollectionException &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a new collection exception object using the given exception ID.
Copy constructor.

Calling Context:

Call this function directly.
Call this function directly when a specific error type is known.
Call this function directly to copy an object.

Parameters:

Takes no parameters .
ECollectionsExceptionID id -The ID for the error that occurred.
const TCollectionException & -The object to copy.

Return Value:

None.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCollectionException::~TCollectionException

virtual ~ TCollectionException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly 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: TCollectionException::operator=

const TCollectionException & operator =(const TCollectionException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

const TCollectionException & -The object to be copied.

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: TCollectionException::GetReason

ECollectionsExceptionID GetReason () const

Interface Category:

API.

Purpose:

Returns the exception ID associated with this TCollectionException.

Calling Context:

Call this function directly to return the exception ID associated with this TCollectionException. Call this function directly to get the reason for the exception.

Parameters:

Takes no parameters.

Return Value:

Returns the ECollectionExceptionID associated with this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCollectionException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Call this function directly to throw this exception. Call this function directly to throw it.

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.