PRTPLAY
8.2I, PLBCMP GUI Only
The PRTPLAY instruction allows output of a spool file created using the PRTOPEN instruction to a specified Windows printer device. The instruction uses the following format:
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
spool file
Required. A previously defined Character String Variable or Literal containing the name of the spool file.
prtname
Required. A previously defined Character String Variable or Literal containing the printer name.
options
Optional. One or more of the keywords listed below.
Flags Affected: NONE
Note the following:
If {spool file} is a Null String, the open file dialog is displayed.
If a hyphen (-) is specified for {prtname}, the settings for the last print open dialog or PAGESETUP instruction are used.
If a printer name of "@" or "@printer name" is specified, a Print Preview is performed.
If {prtname} is a Null String, the standard Windows print dialog is displayed.
An {ip address} may be appended to the {spool file} file name. This generates the advanced print spool file at the SUNDM data manager identified by the {ip address}.
{options} may be one or more of the following strings:
|
Option |
Specifies the ... |
|
CANCELKEY={nvar | ivar} |
a numeric variable that is assigned a value of one if the print dialog was canceled. Note that an S10 error will still occur if the dialog is canceled. If the user program TRAPs the S10 error, the CANCELKEY variable value is set accordingly. |
|
COPYCOUNT={nvar | ivar} |
a numeric variable that identifies the current setting of the printer driver copy parameter when a printing operation was performed. |
|
DIALOG={value} |
whether a print dialog should be presented when a Print is selected from a Print Preview operation. When the {value} is zero, a print dialog does not appear. When the {value} is not zero, a print dialog does appear. When this option is not specified, the default action is a {value} of zero. |
|
ENDPAGE={value} |
the ending physical page is the last page in the Print Preview presentation. If this option is not specified, the last page defaults to the last paged generated by a PRTPAGE operation before the PRTCLOSE operation. |
|
GOTOPAGE={value} |
the first page presented from the print preview page set being used. The {value} should be between one and the last logical page being reviewed. |
|
JOBNAME={value} |
Windows job name. |
|
MAXIMIZE={value} |
whether the Print Preview window starts in a maximized state. A {value} of zero (0) indicates that the window is not maximized when started. This is also the default starting state. Any non-zero {value} indicates that the window should start in a maximized state. |
|
NOPRINT |
that data should be spooled only. The PRINT button is disabled. |
|
PAGECOUNT={nvar | ivar} |
a numeric variable that identifies the number of pages printed. If the value returned is zero, no pages were printed. This keyword indicates whether a user printed from a Print Preview window. |
|
STARTPAGE={value} |
the beginning physical page is page one in the Print Preview presentation. If this option is not specified, page one defaults to the first physical page generated after the PRTOPEN operation. |
|
ZOOM={value} |
the initial zoomed state for the Print Preview window. {value} can be in the range of zero (0) to six (6) inclusive. A {value} of zero indicates that zooming should start a the minimum size. This is the default starting zoom state when this keyword is not provided. A {value} of six indicates that zooming should start at the maximum size. |
Additional information regarding this instruction is available at PDF PRTPLAY Notes.
When executing a PRTPLAY instruction using the PL/B Application server (i.e., Plbserve), output local to the server system is not supported. Therefore, the PRTPLAY instruction always renders the {device} output to the PLBCLIENT client workstation.
The PRTPLAY instruction is not supported by the PL/B Web Server runtime. In this case, an U67 error occurs.
See Also: PRTOPEN, Printer Instructions
|
|