![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MCollectible
Inherited By:
TPrinter
Purpose:
Base class protocol for getting to the attributes and parameters of printers, and also for print job handling. Derived classes of MBasePrinter represent physical printers.
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.
virtual ~ MBasePrinter ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateDefaultPageDescription
virtual TPageDescription * CreateDefaultPageDescription ()
Interface Category:
API.
Purpose:
Returns the default page description (TPageDescription) for this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TPageDescription that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateCurrentPageDescription
virtual TPageDescription * CreateCurrentPageDescription ()
Interface Category:
API.
Purpose:
Returns the current page description (TPageDescription) for this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TPageDescription that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreatePageDescriptionIterator
virtual TPageDescriptionIterator * CreatePageDescriptionIterator () const
Interface Category:
API.
Purpose:
Returns an iterator for TPageDescriptions available on this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TPageDescriptionIterator that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreatePrintMediaIterator
virtual TPrintMediaIterator * CreatePrintMediaIterator () const
Interface Category:
API.
Purpose:
Returns an iterator for TPrintMedias available on this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TPrintMediaIterator that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateSourceTrayIterator
virtual TSourceTrayIterator * CreateSourceTrayIterator () const
Interface Category:
API.
Purpose:
Returns an iterator for TSourceTrays available on this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TSourceTrayIterator that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateDocumentFinishIterator
virtual TDocumentFinishIterator * CreateDocumentFinishIterator () const
Interface Category:
API.
Purpose:
Returns an iterator for TDocumentFinishes available on this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TDocumentFinishIterator that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateDestinationBinIterator
virtual TDestinationBinIterator * CreateDestinationBinIterator () const
Interface Category:
API.
Purpose:
Returns an iterator for TDestinationBins available on this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to a TDestinationBinIterator that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateResolutionIterator
virtual TIteratorOver < TResolutionRange > * CreateResolutionIterator () const
Interface Category:
API.
Purpose:
Creates an iterator that can be used to interrogate a device for the possible resolution ranges available on it. The iterator created might have only one resolution if that's all capability the device has.
Calling Context:
Called directly to acquire a collection of resolutions available on a device.
Parameters:
Return Value:
A pointer to a resolution iterator is returned which is then owned by the caller.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CreateJobDescription
virtual TDeviceJobDescription * CreateJobDescription () const
Interface Category:
API.
Purpose:
Returns the device job description object (TDeviceJobDescription) for this printer.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to TDeviceJobDescription that clients must delete when done.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CopyAllJobs
virtual void CopyAllJobs (TPrintJobCollection &) const
Interface Category:
API.
Purpose:
Copies all TPrintJobHandles in the collection supplied.
Calling Context:
Call this function directly.
Parameters:
- TPrintJobCollection & -The collection to fill in. The client is responsible for deleting TPrintJobHandles in the collection.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::CancelAllJobs
virtual void CancelAllJobs ()
Interface Category:
API.
Purpose:
Cancels all print jobs in this printers queue.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::DeferAllJobs
virtual void DeferAllJobs ()
Interface Category:
API.
Purpose:
Defers all jobs in this printers queue indefinitely.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::DeferAllJobsUntil
virtual void DeferAllJobsUntil (const TTime & when)
Interface Category:
API.
Purpose:
Defers all jobs in this printers queue until the specified time.
Calling Context:
Call this function directly.
Parameters:
- const TTime & when -The time until which the print jobs are to be deferred.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::UndeferAllJobs
virtual void UndeferAllJobs ()
Interface Category:
API.
Purpose:
Resumes all jobs. Makes them all ready to print.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::AddJob
virtual void AddJob (TPrintJobHandle & job)
Interface Category:
API.
Purpose:
Adds a print job to the printers queue.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::RemoveJob
virtual void RemoveJob (TPrintJobHandle & job)
Interface Category:
API.
Purpose:
Removes the given print job from the queue.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::PauseJob
virtual void PauseJob (TPrintJobHandle &)
Interface Category:
API.
Purpose:
Pauses the given print job.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::DeferJob
virtual void DeferJob (TPrintJobHandle &)
Interface Category:
API.
Purpose:
Defers the given print job.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::DeferJobUntil
virtual void DeferJobUntil (TPrintJobHandle &, const TTime &)
Interface Category:
API.
Purpose:
Defers the given print job until a certain time.
Calling Context:
Call this function directly.
Parameters:
- TPrintJobHandle & -The print job to be deferred.
- const TTime & -The time until which the job is to be deferred.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::UndeferJob
virtual void UndeferJob (TPrintJobHandle &)
Interface Category:
API.
Purpose:
Resumes the given job.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::operator<<=
virtual TStream & operator <<= (TStream & fromwhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & fromWhere -The stream the object is streamed in from.
Return Value:
Returns a reference to the stream the object streams itself in from.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::operator>>=
virtual TStream & operator >>=(TStream & towhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & toWhere -The stream the object is streamed out to.
Return Value:
Returns a reference to the stream the object streams itself out to.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual long Hash () const
Interface Category:
API.
Purpose:
Generates a hash value.
Calling Context:
Called to generate a hash value.
Parameters:
Return Value:
A long hash value.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- MBasePrinter ()
- MBasePrinter (const MBasePrinter &)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
Calling Context:
- Called by the stream-in operators.
- Called to copy an object.
Parameters:
- Takes no parameters.
- const MBasePrinter & -The object to be copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: MBasePrinter::operator=
MBasePrinter & operator =(const MBasePrinter &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
Return Value:
A non-const reference to the left-hand side object.
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.
Copyright©1995 Taligent,Inc. All rights reserved.