Class: TTextEditException

Declaration: TextEditException.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TTextEditException, derived from TStandardException, is used to indicate exceptions that are specific to the Text Editing Framework.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly. You can derive to include additional exceptions specific to your work with the framework.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TTextEditException::TTextEditException

TTextEditException (ECause)
TTextEditException (const TTextEditException &)
TTextEditException ()

Interface Category:

API.

Purpose:

Constructs an exception with the specified ECause identifier.
Copy constructor.
Default constructor.

Calling Context:

Called to create an exception. Typically not called directly by clients. May be called by derived classes.
Called to copy an object. Typically not called directly by clients.
Called by the stream-in operators. Typically not called directly by clients.

Parameters:

ECause -The identifier for this exception.
const TTextEditException & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextEditException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception object.

Calling Context:

Called by low-level communication services when the type of this object is not known. Should not be called by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws this exception instance.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextEditException::operator=

TTextEditException & operator =(const TTextEditException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTextEditException & -The object to assign to this 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: TTextEditException::GetCause

ECause GetCause () const

Interface Category:

API.

Purpose:

Returns an ECause value identifying the name, and therefore the cause, of this exception.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

An ECause value identifying the this exception.

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.