Jump to content

WPPrinter: Difference between revisions

From EDM2
No edit summary
Ak120 (talk | contribs)
No edit summary
Line 1: Line 1:


==Setup strings for Printer objects==
==Setup strings for Printer objects==
Captured from a message in a public CompuServe Forum
Captured from a message in a public CompuServe Forum
Author: Dick Goran, (see EMail Addresses) (see also Print to a file, (see also Setup strings for Network Printer objects, and Release or hold a printer queue)
Author: Dick Goran, (see EMail Addresses) (see also Print to a file, (see also Setup strings for Network Printer objects, and Release or hold a printer queue)


The information below is copied from the third edition of the
The information below is copied from the third edition of the [[REXX Reference Summary Handbook]]:
REXX Reference Summary Handbook:
{|class="wikitable"
 
|+Class WPPrinter
  Class WPPrinter
!Key Name
 
!Value
  Key Name         Value         Description
!Description
  ---------------------------------------------------------
|-
  APPDEFAULT       YES | NO       This PrintObject is, or
|APPDEFAULT||YES | NO||This PrintObject is, or is not, to become the application's default PrintObject for printing.
                                  is not, to become the
|-
                                  application's default
|DEFAULTVIEW||DETAILS | ICON||Specifies the default open view for this PrintObject.
                                  PrintObject for
|-
                                  printing.
|JOBDIALOGBEFORE PRINT||NO | YES||Specifies whether the job properties dialog is displayed before printing.
 
|-
  DEFAULTVIEW     DETAILS | ICON
|JOBPROPERTIES||filename||The complete path to a binary file containing the default job properties for this PrintObject. 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.<br /><br />For more information about spooler functions, see the Presentation Manager Programming Reference.
                                  Specifies the default
|-
                                  open view for this
|OUTPUTTOFILE||NO | YES||Specifies if the output of this PrintObject goes to a file. The user will be prompted for a filename each time a print job is submitted to this PrintObject.
                                  PrintObject.
|-
 
|PORTNAME||portname||The names of already installed ports (i.e. LPTx, COMx) to which this PrintObject is to be attached. In the case of more than one port, specify a comma-separated list.
  JOBDIALOGBEFORE PRINT
|-
                  NO | YES       Specifies whether the
|PRINTDRIVER||driver.device||The complete name of the print driver that this PrintObject is to use. For example: 'IBM42XX.IBM 420 Proprinter III', 'LASERJET.HP LaserJet Series II'. In the case of more than one print driver, specify a comma-separated list.
                                  job properties dialog
These printer drivers must already be installed.
                                  is displayed before
|-
                                  printing.
|PRINTERSPECIFICFORMAT||YES||The PrintObject spools print jobs in PM_Q_RAW format.
 
|-
  JOBPROPERTIES   filename       The complete path to a
| ||NO||The PrintObject spools print jobs in PM_Q_STANDARD format.
                                  binary file containing
|-
                                  the default job
|PRINTWHILESPOOLING||NO | YES||Printing is not, or is, enabled while the job is spooling.
                                  properties for this
|-
                                  PrintObject. This file
|QSTARTTIME||time||The time when the PrintObject starts printing. The time format is HH:MM, and
                                  can be created by
the base is a 24-hour clock.
                                  saving the
|-
                                  PRQINFO3->pDriverData
|QSTOPTIME||time||The time when the PrintObject is to stop printing. The time format is HH:MM, and the base is a 24-hour clock.
                                  data to a file; this
|-
                                  data can be obtained by
|QUEUENAME||queue_name||The local queue_name for the PrintObject. If a queue name is not specified, one is created by the PrintObject. The queue_name key will be ignored if this object
                                  using the SplQueryQueue
has already been assigned a queue.
                                  API of the spooler.
|-
 
|QUEUEDRIVER||qdrvname||The queue driver name. The queue driver must already be installed and will usually be PMPRINT.
                                  For more information
|-
                                  about spooler
|SEPARATORFILE||filename||A separator file that prints before each print job.
                                  functions, see the
|}
                                  Presentation Manager
                                  Programming Reference.
 
  OUTPUTTOFILE     NO | YES       Specifies if the output
                                  of this PrintObject
                                  goes to a file. The
                                  user will be prompted
                                  for a filename each
                                  time a print job is
                                  submitted to this
                                  PrintObject.
 
  PORTNAME         portname       The names of already
                                  installed ports (i.e.
                                  LPTx, COMx) to which
                                  this PrintObject 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 PrintObject is to
                                  use. For example:
                                  'IBM42XX.IBM 420
                                  Proprinter III',
                                  'LASERJET.HP LaserJet
                                  Series II'. In the case
                                  of more than one print
                                  driver, specify a
                                  comma-separated list.
                                  These printer drivers
                                  must already be
                                  installed.
 
  PRINTERSPECIFICFORMAT
                  YES           The PrintObject spools
                                  print jobs in PM_Q_RAW
                                  format.
 
                  NO             The PrintObject spools
                                  print jobs in
                                  PM_Q_STANDARD format.
 
  PRINTWHILESPOOLING
                  NO | YES       Printing is not, or is,
                                  enabled while the job
                                  is spooling.
 
  QSTARTTIME       time           The time when the
                                  PrintObject starts
                                  printing. The time
                                  format is HH:MM, and
                                  the base is a 24-hour
                                  clock.
 
  QSTOPTIME       time           The time when the
                                  PrintObject is to stop
                                  printing. The time
                                  format is HH:MM, and
                                  the base is a 24-hour
                                  clock.
 
  QUEUENAME       queue_name     The local queue_name
                                  for the PrintObject. If
                                  a queue name is not
                                  specified, one is
                                  created by the
                                  PrintObject. The
                                  queue_name key will be
                                  ignored if this object
                                  has already been
                                  assigned a queue.
 
  QUEUEDRIVER     qdrvname       The queue driver name.
                                  The queue driver must
                                  already be installed
                                  and will usually be
                                  PMPRINT.
 
  SEPARATORFILE   filename       A separator file that
                                  prints before each
                                  print job.


[[Category:The OS/2 API Project]]
[[Category:The OS/2 API Project]]

Revision as of 20:56, 12 June 2016

Setup strings for Printer objects

Captured from a message in a public CompuServe Forum Author: Dick Goran, (see EMail Addresses) (see also Print to a file, (see also Setup strings for Network Printer objects, and Release or hold a printer queue)

The information below is copied from the third edition of the REXX Reference Summary Handbook:

Class WPPrinter
Key Name Value Description
APPDEFAULT NO This PrintObject is, or is not, to become the application's default PrintObject for printing.
DEFAULTVIEW ICON Specifies the default open view for this PrintObject.
JOBDIALOGBEFORE PRINT YES Specifies whether the job properties dialog is displayed before printing.
JOBPROPERTIES filename The complete path to a binary file containing the default job properties for this PrintObject. 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 Specifies if the output of this PrintObject goes to a file. The user will be prompted for a filename each time a print job is submitted to this PrintObject.
PORTNAME portname The names of already installed ports (i.e. LPTx, COMx) to which this PrintObject 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 PrintObject is to use. For example: 'IBM42XX.IBM 420 Proprinter III', 'LASERJET.HP LaserJet Series II'. In the case of more than one print driver, specify a comma-separated list.

These printer drivers must already be installed.

PRINTERSPECIFICFORMAT YES The PrintObject spools print jobs in PM_Q_RAW format.
NO The PrintObject spools print jobs in PM_Q_STANDARD format.
PRINTWHILESPOOLING YES Printing is not, or is, enabled while the job is spooling.
QSTARTTIME time The time when the PrintObject starts printing. The time format is HH:MM, and

the base is a 24-hour clock.

QSTOPTIME time The time when the PrintObject is to stop printing. The time format is HH:MM, and the base is a 24-hour clock.
QUEUENAME queue_name The local queue_name for the PrintObject. If a queue name is not specified, one is created by the PrintObject. The queue_name key will be ignored if this object

has already been assigned a queue.

QUEUEDRIVER qdrvname The queue driver name. The queue driver must already be installed and will usually be PMPRINT.
SEPARATORFILE filename A separator file that prints before each print job.