Class: TCaucusException

Declaration: Caucus.h

Taxonomy Categories:

Member Functions:

TCaucusException
~TCaucusException
GetReason
operator=
operator>>=
operator<<=
Throw

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TCaucusException derives from TStandardException and provides a way of catching and dealing with caucus exceptions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCaucusException::TCaucusException

TCaucusException (ECause error)
TCaucusException (const TCaucusException &)

Interface Category:

API.

Purpose:

Creates a new caucus exception whose cause is indicated by the specified ECause.
Copy constructor.

Calling Context:

Call this function directly.
Called to copy an object.

Parameters:

ECause error -The cause of the new exception.
const TCaucusException & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCaucusException::~TCaucusException

virtual ~ TCaucusException ()

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: TCaucusException::GetReason

unsigned long GetReason () const

Interface Category:

API.

Purpose:

Returns the reason for the exception. This function delegates to TStandardException's GetReason function.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the reason for the exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCaucusException::operator=

TCaucusException & operator =(const TCaucusException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TCaucusException & -The object to be copied.

Return Value:

Returns a 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: TCaucusException::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

Return Value:

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

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCaucusException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

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.