Class: TDocumentFinishIterator

Declaration: Printer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

An abstract class for iterating over document finishes on a printer.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Deriving classes must implement all functions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentFinishIterator::~TDocumentFinishIterator

virtual ~ TDocumentFinishIterator ()

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

virtual TDocumentFinishing * Next ()

Interface Category:

API.

Purpose:

Returns the next document finish in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentFinishIterator::First

virtual TDocumentFinishing * First ()

Interface Category:

API.

Purpose:

Returns the first document finish in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentFinishIterator::Remove

virtual void Remove ()

Interface Category:

API.

Purpose:

Removes the current document finish 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.

Member Function: TDocumentFinishIterator::TDocumentFinishIterator

TDocumentFinishIterator ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the derived class default constructor.

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.