Class: TStandardExceptionFormatter

Declaration: ExceptionFormatter.h

Taxonomy Categories:

Member Functions:

TStandardExceptionFormatter
~TStandardExceptionFormatter
operator=
operator<<=
operator>>=
Format

Interface Category:

API.

Inherits From:

TExceptionFormatter

Inherited By:

None.

Purpose:

TStandardExceptionFormatter is a class that provides basic error message formatting. TStandardExceptionFormatter is used by default when a custom formatter cannot be found.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TStandardExceptionFormatter.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStandardExceptionFormatter::TStandardExceptionFormatter

TStandardExceptionFormatter ()
TStandardExceptionFormatter (const TStandardExceptionFormatter & other)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TStandardExceptionFormatter object suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TStandardExceptionFormatter & other -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: TStandardExceptionFormatter::~TStandardExceptionFormatter

virtual ~ TStandardExceptionFormatter ()

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

TStandardExceptionFormatter & operator =(const TStandardExceptionFormatter & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardExceptionFormatter & other -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: TStandardExceptionFormatter::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardExceptionFormatter::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardExceptionFormatter::Format

virtual void Format (const TStandardException & exception, TArchive * Archive, const TLocale & Locale, TText & Message)

Interface Category:

API.

Purpose:

Formats an error message for the specified exception, using the specified message archive. If the parameter Archive is NIL, formats a default error message containing the exception class name and enum value. The parameter Message is filled in with the resulting message.

Calling Context:

Called to format an error message.

Parameters:

const TStandardException & exception -The exception for which the error message is to be formatted.
TArchive * Archive -The message archive to use. If this parameter is NIL, a default error message is formatted.
const TLocale & Locale -Used as a key to look up localized presentation or names in the archive.
TText & Message -Used to hold the message that is formatted.

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.