Syntax 2 For canceling a print job
Description
Cancels printing of a print job that you opened with the PrintOpen function.
The print job is identified by the number returned by PrintOpen.
Controls
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control |
Syntax
[PowerBuilder]
|
1 |
integer <span>PrintCancel </span>( long <span>printjobnumber</span> ) |
|
Argument |
Description |
|---|---|
|
printjobnumber |
The number the PrintOpen function |
Return Values
Returns 1 if it succeeds and –1 if an error occurs.
If printjobnumber is null, PrintCancel returns
null.
Usage
PrintCancel cancels the specified print
job by deleting the spool file, if any, and closing the job. Because PrintCancel closes
the print job, do not call the PrintClose function
after you call PrintCancel.
Examples
In this example, a script for a Print button opens
a print job and then opens a window with a cancel button. If the
user clicks on the cancel button, its script sets a global variable
that indicates that the user wants to cancel the job. After each
printing command in the Print button’s script, the code checks
the global variable and cancels the job if its value is true.
The definition of the global variable is:
|
1 |
boolean gb_printcancel |
The script for the Print button is:
|
1 |
long job, li |
|
1 |
|
1 |
gb_printcancel = false |
|
1 |
job = PrintOpen("Test Page Breaks") |
|
1 |
IF job < 1 THEN |
|
1 |
MessageBox("Error", "Can't open a print job.") |
|
1 |
RETURN |
|
1 |
END IF |
|
1 |
|
1 |
Open(w_printcancel) |
|
1 |
|
1 |
PrintBitmap(Job, "d:PBitmap1.bmp", 5, 10, 0, 0) |
|
1 |
IF gb_printcancel = true THEN |
|
1 |
<span> PrintCancel</span>(job) |
|
1 |
RETURN |
|
1 |
END IF |
|
1 |
|
1 |
... // Additional printing commands, |
|
1 |
... // including checking gb_printcancel |
|
1 |
|
1 |
PrintClose(job) |
|
1 |
Close(w_printcancel) |
The script for the cancel button in the second window
is:
|
1 |
gb_printcancel = true |
|
1 |
Close(w_printcancel) |
See Also
-
PrintCancel in the PowerScript Reference
-
PrintClose in the PowerScript Reference
-
PrintOpen in the PowerScript Reference