Class: TMessageStreamException

Declaration: MessageStream.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

TRequestReplyException

Purpose:

TMessageStreamException is thrown when exceptional conditions occur in TMessageStream.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TMessageStreamException::TMessageStreamException

TMessageStreamException ()
TMessageStreamException (ErrorType err, long msg =0)
TMessageStreamException (ErrorType err, long msg, char * msgStr, void * cd)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TMessageStreamException with the specified error type and message.

Calling Context:

Called by the stream-in operators and anywhere the definition of a TMessageStreamException is desired.
Called to create a TMessageStreamException with the specified error type and message.
Called to create a TMessageStreamException with the specified error type, message, and message string.

Parameters:

Takes no parameters.
ErrorType err -The major error type.
long msg -The minor error type.
ErrorType err -The major error type.
long msg -The minor error type.
char * msgStr -A message string.
void * cd -Not used.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMessageStreamException::~TMessageStreamException

virtual ~ TMessageStreamException ()

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

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Called when an exceptional condition occurs. 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.

Member Function: TMessageStreamException::GetReason

unsigned long GetReason () const

Interface Category:

API.

Purpose:

Overrides the inherited TStandardException function. Gets the reason why this exception was thrown.

Calling Context:

Called after catching this exception.

Parameters:

Takes no parameters.

Return Value:

Returns the errror code.

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.