Class: TStandardPrintJobIterator

Declaration: Printer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPrintJobIterator

Inherited By:

None.

Purpose:

A concrete derived class of TPrintJobIterator to iterate over print jobs in a printers queue.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class. Derive from TPrintJobIterator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardPrintJobIterator::TStandardPrintJobIterator

TStandardPrintJobIterator (const TPrintJobCollection * list)
TStandardPrintJobIterator ()

Interface Category:

API.

Purpose:

The main constructor to be used by clients.
Default constructor.

Calling Context:

Called when iterating over print jobs.
Called by the derived class (if any) default constructor.

Parameters:

const TPrintJobCollection * list -The list to iterate over.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardPrintJobIterator::~TStandardPrintJobIterator

virtual ~ TStandardPrintJobIterator ()

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

virtual TPrintJobHandle * Next ()

Interface Category:

API.

Purpose:

Returns the next print job in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to a TPrintJobHandle object. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardPrintJobIterator::First

virtual TPrintJobHandle * First ()

Interface Category:

API.

Purpose:

Returns the first print job in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to a TPrintJobHandle object. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardPrintJobIterator::Last

virtual TPrintJobHandle * Last ()

Interface Category:

API.

Purpose:

Returns the last print job in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to a TPrintJobHandle object. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardPrintJobIterator::Previous

virtual TPrintJobHandle * Previous ()

Interface Category:

API.

Purpose:

Returns the previous print job in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to a TPrintJobHandle object. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardPrintJobIterator::Remove

virtual void Remove ()

Interface Category:

API.

Purpose:

Removes the current print job from 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.

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