Class: TExceptionEnclosure

Declaration: KernelExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

An abstract base class for all Kernel Exceptions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

KernelException classes.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TExceptionEnclosure::~TExceptionEnclosure

virtual ~ TExceptionEnclosure ()

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: TExceptionEnclosure::GetEnclosedException

TStandardException * GetEnclosedException ()

Interface Category:

API.

Purpose:

Returns a pointer to a TSE object if this exception contains an embedded exception object. Otherwise, returns NIL.

Calling Context:

Called to get access to the native error code. The caller adopts the storage pointed by the returned value.

Parameters:

Takes no parameters.

Return Value:

A pointer to the embedded exception object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The caller is responsible for deleting the storage associated with the return value.

Member Function: TExceptionEnclosure::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws the exception.

Calling Context:

Called by the client code to throw the exception.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws the exception requested.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TExceptionEnclosure::TExceptionEnclosure

TExceptionEnclosure (unsigned long whatHappened =0, TStandardException * adoptThis =NIL)
TExceptionEnclosure (const TExceptionEnclosure & copy)

Interface Category:

API.

Purpose:

Creates an object with a given reason as whatHappened or a TStandardException to be adopted.
Copy constructor.

Calling Context:

Called to create an object.
Called to copy an object.

Parameters:

unsigned long whatHappened =0 -The error.
TStandardException * adoptThis =NIL -The object to be adopted.
const TExceptionEnclosure & 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: TExceptionEnclosure::operator=

TExceptionEnclosure & operator =(const TExceptionEnclosure & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TExceptionEnclosure & copy -The right-hand side object of the assignment.

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: TExceptionEnclosure::SetEnclosedException

void SetEnclosedException (TStandardException * adoptThis)

Interface Category:

API.

Purpose:

Sets the enclosed exception object for this class.

Calling Context:

Called to set the TSE object.

Parameters:

TStandardException * adoptThis -The object to be set.

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.