Class: TTextException

Declaration: Text.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TTextException, derived from TStandardException, is used to identify exceptions that occur during processing of TText and derived classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TTextException::TTextException

TTextException ()
TTextException (ETextExceptionID id)
TTextException (const TTextException &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a TTextException with the specified error ID.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Call to construct a TTextException with a particular error ID.
Called to copy an object.

Parameters:

Takes no parameters.
ETextExceptionID id -The error ID of this exception.
const TTextException & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextException::~TTextException

virtual ~ TTextException ()

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

TTextException & operator =(const TTextException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTextException & -The source object for 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: TTextException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws an exceptions.

Calling Context:

Called directly to throw an exception.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws the TTextException.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextException::GetReason

ETextExceptionID GetReason () const

Interface Category:

API.

Purpose:

Gets the enumeration value representing the reason that the exception was thrown.

Calling Context:

Called directly to get the enumeration value representing the reason that the exception was thrown.

Parameters:

Takes no parameters.

Return Value:

The enumeration value representing the reason that the exception was thrown.

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.