WPPrinter

Class definition file: wpprint.idl

Class hierarchy SOMObject
WPObject
WPAbstract
WPPrinter

Description

This is the printer object class. An instance of this class can be created as a Workplace object. An instance of this class is created initially by the system in its template form. It has the title "Printer" and resides in the "Templates" folder. Instances of this class are also created initially by the system for each print configured. Each instance has a title corresponding to the description of the configured queue and printer and resides on the desktop.

Instance methods

The following list shows all the WPPrinter methods:

wpDeleteAllJobs
wpHoldPrinter
wpJobAdded
wpJobChanged
wpJobDeleted
wpQueryComputerName
wpQueryPrinterName
wpQueryQueueOptions
wpQueryRemoteOptions
wpReleasePrinter
wpSetComputerName
wpSetJobProperties
wpSetDefaultPrinter
wpSetPrinterName
wpSetQueueOptions
wpSetRemoteOptions

SOMObject instance methods

The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.

somDumpSelfInt

WPObject instance methods

The following list shows all the methods overridden by the WPPrinter class. These methods are overridden in order to modify the behavior defined by an ancestor class.

wpMenuItemHelpSelected

wpSetup override by WPPrint

The following table shows the keyname-value pairs added by the WPPrint class.

кФФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФПГKEYNAME                  ГVALUE        ГDESCRIPTION                Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГAPPDEFAULT               ГYES          ГThis printer object is to  Г
Г                         Г             Гbecome the application's   Г
Г                         Г             Гdefault printer object for Г
Г                         Г             Гprinting.                  Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThis printer object is not Г
Г                         Г             Гto become the application'sГ
Г                         Г             Гdefault printer object for Г
Г                         Г             Гprinting.                  Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГDEFAULTVIEW              ГDETAILS      ГDefault open view for this Г
Г                         Г             Гprinter object is in       Г
Г                         Г             Гdetails view.              Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГICON         ГDefault open view for this Г
Г                         Г             Гprinter object is in icon  Г
Г                         Г             Гview.                      Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГJOBDIALOGBEFOREPRINT     ГYES          ГThe job properties dialog  Г
Г                         Г             Гis displayed before        Г
Г                         Г             Гprinting.                  Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThe job properties dialog  Г
Г                         Г             Гis not displayed before    Г
Г                         Г             Гprinting.                  Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГJOBPROPERTIES            Гfilename     ГThe complete path to a     Г
Г                         Г             Гbinary file containing the Г
Г                         Г             Гdefault job properties for Г
Г                         Г             Гthis printer object.  This Г
Г                         Г             Гfile can be created by     Г
Г                         Г             Гsaving the                 Г
Г                         Г             ГPRQINFO3->pDriverData data Г
Г                         Г             Гto a file; this data can beГ
Г                         Г             Гobtained by using the      Г
Г                         Г             ГSplQueryQueue API of the   Г
Г                         Г             Гspooler.                   Г
Г                         Г             ГFor more information about Г
Г                         Г             Гspooler functions, see the Г
Г                         Г             ГPresentation Manager       Г
Г                         Г             ГProgramming Reference.     Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГOUTPUTTOFILE             ГYES          ГThe output of this printer Г
Г                         Г             Гobject goes to a file.  TheГ
Г                         Г             Гuser will be prompted for aГ
Г                         Г             Гfile name each time a printГ
Г                         Г             Гjob is submitted to this   Г
Г                         Г             Гprinter object.            Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThe output of this printer Г
Г                         Г             Гobject does not go to a    Г
Г                         Г             Гfile.                      Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГPORTNAME                 Гportname     ГThe names of already       Г
Г                         Г             Гinstalled ports to which   Г
Г                         Г             Гthis printer object is to  Г
Г                         Г             Гbe attached.  In the case  Г
Г                         Г             Гof more than one port,     Г
Г                         Г             Гspecify a comma-separated  Г
Г                         Г             Гlist.                      Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГPRINTDRIVER              Гdriver.deviceГThe complete name of the   Г
Г                         Г             Гprint-driver that this     Г
Г                         Г             Гprinter object is to use.  Г
Г                         Г             ГFor example: 'IBM42XX.IBM  Г
Г                         Г             Г420 Proprinter III'        Г
Г                         Г             ГIn the case of more than   Г
Г                         Г             Гone print driver, specify aГ
Г                         Г             Гcomma-separated list.      Г
Г                         Г             ГThese printer drivers must Г
Г                         Г             Гalready be installed.      Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГPRINTERSPECIFICFORMAT    ГYES          ГThe printer object spools  Г
Г                         Г             Гprint jobs in PM_Q_RAW     Г
Г                         Г             Гformat.                    Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThe printer object spools  Г
Г                         Г             Гprint jobs in PM_Q_STANDARDГ
Г                         Г             Гformat.                    Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГPRINTWHILESPOOLING       ГYES          ГThe printing is enabled    Г
Г                         Г             Гwhile the job is spooling. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThe printing is disabled   Г
Г                         Г             Гwhile the job is spooling. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГPRIORITY                 Гpriority     ГThis sets the priority of  Г
Г                         Гnumber (0-9) Гthe print queue associated Г
Г                         Г             Гwith the printer object.   Г
Г                         Г             ГAll print jobs that are    Г
Г                         Г             Гsubmitted to the printer   Г
Г                         Г             Гobject will inherit a job  Г
Г                         Г             Гpriority derived from the  Г
Г                         Г             Гprint queue's priority.    Г
Г                         Г             ГZero is the highest        Г
Г                         Г             Гpriority and 9 is the      Г
Г                         Г             Гlowest priority.           Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГQSTARTTIME               Гtime         ГThe time when the printer  Г
Г                         Г             Гobject starts printing.    Г
Г                         Г             ГThe time format is HH:MM,  Г
Г                         Г             Гand the base is a 24-hour  Г
Г                         Г             Гclock.                     Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГQSTOPTIME                Гtime         ГThe time when the printer  Г
Г                         Г             Гobject is to stop printing.Г
Г                         Г             ГThe time format is HH:MM,  Г
Г                         Г             Гand the base is a 24-hour  Г
Г                         Г             Гclock.                     Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГQUEUENAME                Гname         ГThe local queue name for   Г
Г                         Г             Гthe printer object.  If a  Г
Г                         Г             Гqueue name is not          Г
Г                         Г             Гspecified, one is created  Г
Г                         Г             Гby the printer object.     Г
Г                         Г             ГThe QUEUENAME key will be  Г
Г                         Г             Гignored if this object has Г
Г                         Г             Гalready been assigned a    Г
Г                         Г             Гqueue.                     Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГQUEUEPARMS               Гqparm        ГThis sets the queue        Г
Г                         Г             Гparameters, and can be any Г
Г                         Г             Гtext string. Queue         Г
Г                         Г             Гparameters are specific    Г
Г                         Г             Гinstructions that are read Г
Г                         Г             Гand used by OS/2 print     Г
Г                         Г             Гdrivers, OS/2 queue        Г
Г                         Г             Гdrivers, and the OS/2      Г
Г                         Г             Гspooler.                   Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГQUEUEDRIVER              Гqdrvname     ГThe queue driver name. The Г
Г                         Г             Гqueue driver must already  Г
Г                         Г             Гbe installed.              Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГSEPARATORFILE            Гfilename     ГA separator file that      Г
Г                         Г             Гprints before each print   Г
Г                         Г             Гjob.                       Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГSYNCJOBPROP              ГYES          ГThis specifies that the    Г
Г                         Г             Гdefault job properties of  Г
Г                         Г             Гthe printer object are to  Г
Г                         Г             Гbe synchronized with the   Г
Г                         Г             Гnetwork's printer job      Г
Г                         Г             Гproperties.                Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThis specifies that the    Г
Г                         Г             Гdefault job properties willГ
Г                         Г             Гnot be synchronized.       Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГSYNCPRINTERPROP          ГYES          ГThis specifies that the    Г
Г                         Г             Гprinter properties of the  Г
Г                         Г             Гprinter object are to be   Г
Г                         Г             Гsynchronized with the      Г
Г                         Г             Гnetwork's printer job      Г
Г                         Г             Гproperties.                Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThis specifies that the    Г
Г                         Г             Гprinter properties will notГ
Г                         Г             Гbe synchronized.           Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГTAKEDEFAULTS             ГYES          ГThis specifies that the    Г
Г                         Г             Гprinter object takes the   Г
Г                         Г             Гdefault values when it is  Г
Г                         Г             Гcreated.                   Г
УФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                         ГNO           ГThis specifies that the    Г
Г                         Г             Гprinter object does not    Г
Г                         Г             Гtake default values when itГ
Г                         Г             Гis created.  This will     Г
Г                         Г             Гcause the "Create a        Г
Г                         Г             Гprinter" dialog to be      Г
Г                         Г             Гdisplayed.                 Г
РФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФй

Class methods

There are currently no class methods defined for the WPPrinter Workplace class object.

WPObject class methods

The following list shows all the class methods overridden by the WPPrinter class. These methods are overridden to modify the behavior defined by an ancestor class.

[Back] [Next]