Class: TPixelStreamWriterException

Declaration: PixelStreamWriter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TPixelStreamWriterException derives from TStandardException. It is used to handle exceptions that occur when writing pixel streams. This class will possibly be replaced in the future.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TPixelStreamWriterException::TPixelStreamWriterException

TPixelStreamWriterException (EWriterExceptionType type)
TPixelStreamWriterException (const TPixelStreamWriterException &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called when a pixel writer exception occurs to indicate the type of exception.
Called to copy an object.

Parameters:

EWriterExceptionType type -The enumerator value that indicates the type of the exception that occurred.
const TPixelStreamWriterException & -A reference to the object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPixelStreamWriterException::~TPixelStreamWriterException

virtual ~ TPixelStreamWriterException ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TPixelStreamWriterException::GetType

virtual EWriterExceptionType GetType ()

Interface Category:

API.

Purpose:

Gets the tag value that indicates the type of exception that occurred.

Calling Context:

Call this function directly when an exception has occurred.

Parameters:

Takes no parameters.

Return Value:

Returns the EWriterExceptionType enumerator value that indicates the exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPixelStreamWriterException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

This function is called directly only when throwing the TPixelStreamWriterException. tion.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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