Class: TFormatterException

Declaration: Formatter.h

Taxonomy Categories:

Member Functions:

GetErrorID
TFormatterException
operator=
~TFormatterException
Throw

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

Derived from TStandardException, this class encapsulates the exceptions thrown by the formatting classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from TFormatterException to provide additional error identifiers for formatting exceptions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFormatterException::GetErrorID

void GetErrorID (EFormatterExceptionID & id) const

Interface Category:

API.

Purpose:

Returns the error ID for this exception.

Calling Context:

Call this function directly.

Parameters:

EFormatterExceptionID & id -The error identifier for this exception.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFormatterException::TFormatterException

TFormatterException ()
TFormatterException (const TFormatterException & toCopy)
TFormatterException (EFormatterExceptionID error)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructs an exception with the specified error ID.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Call this function directly.

Parameters:

Takes no parameters.
const TFormatterException & toCopy -The object to copy.
EFormatterExceptionID error -The error ID for this exception.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFormatterException::operator=

TFormatterException & operator =(const TFormatterException & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TFormatterException & toCopy -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: TFormatterException::~TFormatterException

virtual ~ TFormatterException ()

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: TFormatterException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception object.

Calling Context:

Called during exception generation. Clients should not call directly.

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.