All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

PrintBase Interface CATIPrinterManager

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIPrinterManager
 

Usage: you can freely reimplement this interface.


interface CATIPrinterManager

Interface for external Printer Managers.


Method Index


o GetConfigurationDialog(CATDialog*,CATPrinter&,CATDlgWindow*&)
Builds a configuration dialog for the given printer.
o GetExtendedOptionsDialog(CATDialog*,CATPrinter&,CATDlgWindow*&)
Builds a dialog box for extended options (scheduling,.
o GetExtendedOptionsInfos(CATPrinter&,CATUnicodeString&)
Gets information on extended options of the given printer.
o GetLastError(CATUnicodeString&)
Gets the last error message.
o GetPrinterList(CATLISTP(CATPrinter)&)
Gets the list of available printers .
o GetPrinterManagerDialog(CATDialog*,CATDlgWindow*&)
Builds the printer manager dialog.
o GetPrinterStatus(CATPrinter&,CATUnicodeString&)
Gets the status of the given printer.
o GetStatusDialog(CATDialog*,CATPrinter&,CATDlgWindow*&)
Builds a status dialog for the given printer.
o IsExtendedOptionsSupport(void)
Asks for extented options support (scheduling,.
o Print(CATPrinterDevice&,CATPrintParameters&,CATPrintImage*)
Prints an image on a printer with given parameters.

Methods


o GetConfigurationDialog
public virtual HRESULT GetConfigurationDialog(CATDialog* iParent,
CATPrinter& iPrinter,
CATDlgWindow*& oDialog) = 0
Builds a configuration dialog for the given printer.
Parameters:
iParent
The parent dialog.
iPrinter
The printer for which the dialog is to be displayed.
Returns:
S_OK upon successful execution.
o GetExtendedOptionsDialog
public virtual HRESULT GetExtendedOptionsDialog(CATDialog* iParent,
CATPrinter& iPrinter,
CATDlgWindow*& oDialog) = 0
Builds a dialog box for extended options (scheduling,...) for the given printer.
Parameters:
iParent
The parent dialog.
iPrinter
The printer for which the dialog is to be displayed.
oDialog
A pointer to the dialog.
Returns:
S_OK upon successful execution.
o GetExtendedOptionsInfos
public virtual HRESULT GetExtendedOptionsInfos(CATPrinter& iPrinter,
CATUnicodeString& oStatus) = 0
Gets information on extended options of the given printer.
Parameters:
iPrinter
The printer for which the information is to be displayed.
oStatus
A string describing information about extended options (scheduling mode activated, ...).
Returns:
S_OK upon successful execution.
o GetLastError
public virtual HRESULT GetLastError(CATUnicodeString& oError) = 0
Gets the last error message.
Parameters:
oError
The error messsage.
Returns:
S_OK upon successful execution.
o GetPrinterList
public virtual HRESULT GetPrinterList(CATLISTP(CATPrinter)& ioPrinterList) = 0
Gets the list of available printers .
Parameters:
ioPrinterList
The list to be filled (initially empty).
Returns:
S_OK upon successful execution.
o GetPrinterManagerDialog
public virtual HRESULT GetPrinterManagerDialog(CATDialog* iParent,
CATDlgWindow*& oDialog) = 0
Builds the printer manager dialog.
Parameters:
iParent
The parent dialog.
oDialog
A pointer to the dialog.
Returns:
S_OK upon successful execution.
o GetPrinterStatus
public virtual HRESULT GetPrinterStatus(CATPrinter& iPrinter,
CATUnicodeString& oStatus) = 0
Gets the status of the given printer.
Parameters:
iPrinter
The printer for which the dialog is to be displayed.
oStatus
A string describing the status of the printer (Idle, Busy, etc.).
Returns:
S_OK upon successful execution.
o GetStatusDialog
public virtual HRESULT GetStatusDialog(CATDialog* iParent,
CATPrinter& iPrinter,
CATDlgWindow*& oDialog) = 0
Builds a status dialog for the given printer.
Parameters:
iParent
The parent dialog.
iPrinter
The printer for which the dialog is to be displayed.
oDialog
A pointer to the dialog.
Returns:
S_OK upon successful execution.
o IsExtendedOptionsSupport
public virtual HRESULT IsExtendedOptionsSupport(void ) = 0
Asks for extented options support (scheduling,...).
Returns:
S_OK if extented options support. E_FAIL if no extented options support.
o Print
public virtual HRESULT Print(CATPrinterDevice& iDevice,
const CATPrintParameters& iParameters,
CATPrintImage* iImage) = 0
Prints an image on a printer with given parameters.
Parameters:
iDevice
The device on which the image is to be printed.
iParameters
The parameters applied to the printout.
iImage
The image to be printed.
Returns:
S_OK upon successful execution.

This object is included in the file: CATIPrinterManager.h
If needed, your Imakefile.mk should include the module: CATPrintBase

Copyright © 2003, Dassault Systèmes. All rights reserved.