Class: TLineLayoutException

Declaration: LineLayout.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

This class, derived from TStandardException, is used to distinguish exceptions occurring within line layout functions from other exceptions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derived classes of Line Layout can provide derived classes of TLineLayoutException for any exceptional conditions they define.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TLineLayoutException::operator=

TLineLayoutException & operator =(const TLineLayoutException & rhs)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLineLayoutException & rhs -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:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutException::~TLineLayoutException

virtual ~ TLineLayoutException ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutException::TLineLayoutException

TLineLayoutException ()
TLineLayoutException (ELineLayoutExceptionID error)
TLineLayoutException (const TLineLayoutException & copy)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TLineLayoutException with a particular exception ID.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to create an exception with a particular ID.
Called to copy an object.

Parameters:

Takes no parameters.
ELineLayoutExceptionID error -The exception ID for this exception.
const TLineLayoutException & copy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutException::GetErrorID

void GetErrorID (ELineLayoutExceptionID & id) const

Interface Category:

API.

Purpose:

Gets the error ID of this exception.

Calling Context:

Call to get the error ID of an exception.

Parameters:

ELineLayoutExceptionID & id -The error ID of this exception.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutException::SetErrorID

void SetErrorID (ELineLayoutExceptionID id)

Interface Category:

API.

Purpose:

Sets the error ID of an exception.

Calling Context:

Call to reset the error ID of an exception after its construction.

Parameters:

ELineLayoutExceptionID id -The new error ID of this exception.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws a TLineLayoutException object.

Calling Context:

Used by the exception handling mechanism to throw a TLineLayoutException object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.