SplQmAbort: Difference between revisions
Created page with "SplQmAbort stops the generation of the spool file. It automatically closes the spool file (see SplQmClose). ==Syntax== rc = SplQmAbort(hspl); ==Parameters== ; hspl (HSPL) ..." |
|||
| Line 48: | Line 48: | ||
==Related Functions== | ==Related Functions== | ||
; Prerequisite Functions | ; Prerequisite Functions | ||
: SplQmOpen | : [[SplQmOpen]] | ||
; Related Functions | ; Related Functions | ||
: DevEscape | : [[DevEscape]] | ||
[[Category:Spl]] | [[Category:Spl]] | ||
Revision as of 19:18, 28 February 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.
Remarks
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);
Example Code
#define INCL_SPL /* Or use INCL_PM, */ #include <os2.h> HSPL hspl; /* Spooler handle. */ BOOL rc; /* Success indicator. */ rc = SplQmAbort(hspl);