Class: TGUIDocumentException

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

TGUIDocumentException
~TGUIDocumentException
operator=
operator>>=
operator<<=
GetCause
Throw

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

Exception class for all GUICompoundDocument exceptions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Can derive from this class to provide your own exception causes.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIDocumentException::TGUIDocumentException

TGUIDocumentException (ECause)
TGUIDocumentException (const TGUIDocumentException &)
TGUIDocumentException ()

Interface Category:

API.

Purpose:

Create an exception for a specific cause.
Copy constructor.
Default constructor.

Calling Context:

Called by the framework when throw an exception.
Called to copy an object.
Called by the stream-in operators.

Parameters:

ECause -The exception cause.
const TGUIDocumentException & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentException::~TGUIDocumentException

~ TGUIDocumentException ()

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

TGUIDocumentException & operator =(const TGUIDocumentException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TGUIDocumentException & -The object to be assigned.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & output -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: TGUIDocumentException::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & input -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: TGUIDocumentException::GetCause

ECause GetCause () const

Interface Category:

API.

Purpose:

Provides access to the cause of the exception.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

ECause -The exception cause.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Rethrows the exception polymorphically.

Calling Context:

Call 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.

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