SplQmAbort: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
SplQmAbort stops the generation of the spool file. It automatically closes the spool file (see SplQmClose). | SplQmAbort stops the generation of the spool file. It automatically closes the spool file (see [[SplQmClose]]). | ||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
; hspl (HSPL) - input | ;hspl (HSPL) - input: Spooler handle. | ||
: Spooler handle. | |||
==Return Code== | ==Return Code== | ||
; rc (BOOL) - returns | ;rc (BOOL) - returns: Success indicator. | ||
: Success indicator. | * TRUE Successful completion | ||
* FALSE Error occurred. | |||
* TRUE Successful completion | ;Error Conditions: Possible returns from WinGetLastError | ||
* FALSE Error occurred. | ::PMERR_SPL_QUEUE_ERROR (0x4004) No spooler queue supplied or found. | ||
::PMERR_SPL_INV_HSPL (0x4005) The spooler handle is invalid. | |||
; Error Conditions | |||
: Possible returns from WinGetLastError | |||
PMERR_SPL_QUEUE_ERROR (0x4004) | |||
No spooler queue supplied or found. | |||
PMERR_SPL_INV_HSPL (0x4005) | |||
The spooler handle is invalid. | |||
==Sample== | ==Sample== | ||
This function is used to stop the generation of spool files and automatically close the spool file. | This function is used to stop the generation of spool files and automatically close the spool file. | ||
<PRE> | <PRE> | ||
#define INCL_SPL | #define INCL_SPL | ||
| Line 47: | Line 38: | ||
==Related Functions== | ==Related Functions== | ||
; Prerequisite Functions | ;Prerequisite Functions: [[SplQmOpen]] | ||
: [[SplQmOpen]] | ;Related Functions: [[DevEscape]] | ||
; Related Functions | |||
: [[DevEscape]] | |||
[[Category:Spl]] | [[Category:Spl]] | ||
Latest revision as of 22:04, 25 March 2020
SplQmAbort stops the generation of the spool file. It automatically closes the spool file (see SplQmClose).
Syntax
rc = SplQmAbort(hspl);
Parameters
- hspl (HSPL) - input
- Spooler handle.
Return Code
- rc (BOOL) - returns
- Success indicator.
- TRUE Successful completion
- FALSE Error occurred.
- Error Conditions
- Possible returns from WinGetLastError
- PMERR_SPL_QUEUE_ERROR (0x4004) No spooler queue supplied or found.
- PMERR_SPL_INV_HSPL (0x4005) The spooler handle is invalid.
Sample
This function is used to stop the generation of spool files and automatically close the spool file.
#define INCL_SPL #include <OS2.H> HSPL hspl; /* spooler handle. */ SplQmAbort(hspl);
Calling Sequence
#define INCL_SPL /* Or use INCL_PM, */ #include <os2.h> HSPL hspl; /* Spooler handle. */ BOOL rc; /* Success indicator. */ rc = SplQmAbort(hspl);