Class: TDisplayException

Declaration: Display.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

Derived from TStandardException, this class is used for throwing exceptions that occur when there are problems connecting to the host windowing environment. Typically, these problems occur when calling screen constructors and through TDisplay::GetScreen.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDisplayException::TDisplayException

TDisplayException(EViolation error)
TDisplayException(const TDisplayException& other)
TDisplayException()

Interface Category:

API.

Purpose:

Constructor used when the specific error is known.
Copy constructor.
Default constructor.

Calling Context:

Called to throw a specific exception.
Called to copy an object.
Called by the stream-in operators.

Parameters:

EViolation error -The enumerator tag that identifies the error.
const TDisplayException& other -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayException::~TDisplayException

virtual ~TDisplayException()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy the 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: TDisplayException::operator=

TDisplayException & operator =(const TDisplayException& other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDisplayException& other -The object to be assigned to TDisplayException.

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

void Throw() const

Interface Category:

API.

Purpose:

Throws a TDisplayException.

Calling Context:

Called this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayException::GetReason

virtual EViolation GetReason() const

Interface Category:

API.

Purpose:

Gets the reason associated with the TDisplayException exception object, according to the enumerator tag.

Calling Context:

Called this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the enum that specifies the reason.

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.