Class: TWindowException

Declaration: Window.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TWindowException derives from TStandardException and provides exception handling for classes interacting with windows and window layers. This class publicly defines an enumerated type containing all of the supported exception types for windows and window layers. Use the member function GetCause to query a TWindowException object for the type of error that caused the exception. The cause of a TWindowException object can only be set during construction.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Rarely derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TWindowException::TWindowException

TWindowException (ECause)
TWindowException (const TWindowException &)
TWindowException ()

Interface Category:

API.

Purpose:

Creates a TWindowException object and initializes it with the specified ECause value. A TWindowException's cause can only be set with this constructor.
Copy constructor.
Default constructor.

Calling Context:

You can call this function directly.
Called to copy an object.
Called by the stream-in operators.

Parameters:

ECause -The cause of this exception.
const TWindowException & -The TWindowException 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: TWindowException::~TWindowException

~ TWindowException ()

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

TWindowException & operator =(const TWindowException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TWindowException & -The TWindowException 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: TWindowException::GetCause

ECause GetCause () const

Interface Category:

API.

Purpose:

GetCause returns the type of error that caused this exception. GetCause returns a value of the enumerated type ECause defined by this class.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ECause value indicating the error type that caused this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TWindowException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception object.

Calling Context:

Called during exception propagation between processes. Clients should not call directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws this exception.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TWindowException::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The data to stream in.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The data to stream out.

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.

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