Class: TStreamException

Declaration: StreamException.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TStreamException is a class that is thrown to indicate exception conditions that occur during streaming operations.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TStreamException.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStreamException::TStreamException

TStreamException ()
TStreamException (EStreamExceptionID id)
TStreamException (const TStreamException &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TStreamException initialized with the EStreamExceptionID that was passed.
Copy constructor.

Calling Context:

Call this function directly anywhere the creation of a TStreamException is desired.
Call this function directly to create a TStreamException with a specific exception ID.
Call this function directly to copy an object.

Parameters:

Takes no parameters.
EStreamExceptionID id -The exception ID to use.
const TStreamException & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStreamException::~TStreamException

virtual ~ TStreamException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly 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: TStreamException::operator=

const TStreamException & operator =(const TStreamException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

const TStreamException & -The object to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStreamException::GetReason

EStreamExceptionID GetReason () const

Interface Category:

API.

Purpose:

Returns the exception ID associated with this TStreamException.

Calling Context:

Call this function directly to return the exception ID associated with this TStreamException.

Parameters:

Takes no parameters.

Return Value:

Returns the EStreamExceptionID associated with this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStreamException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Call this function directly to throw this exception.

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.