Class: TPrintMediaIterator

Declaration: PageDescription.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

An abstract base class for an object that can be used to iterate through a list of TPrintMedia obtained from a TPrinter object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Clients are not expected to derive from this class. However, developers writing Printer Handlers for various printers should derive from this class to provide a list of available media. Next, First, and Remove must be overridden to provide standard iterator behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPrintMediaIterator::~TPrintMediaIterator

virtual ~ TPrintMediaIterator ()

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: TPrintMediaIterator::Next

virtual TPrintMedia * Next ()

Interface Category:

API.

Purpose:

Gets the next element in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the TPrintMedia pointer to the next element in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintMediaIterator::First

virtual TPrintMedia * First ()

Interface Category:

API.

Purpose:

Gets the first element in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the TPrintMedia pointer to the first element in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintMediaIterator::Remove

virtual void Remove ()

Interface Category:

API.

Purpose:

Removes the current element in the list.

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.

Member Function: TPrintMediaIterator::TPrintMediaIterator

TPrintMediaIterator ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the stream-in operators

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This constructor is protected.

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