Jump to content

SplQmAbort: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
 
(One intermediate revision by one other user not shown)
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.
;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.


* TRUE Successful completion
==Sample==
* FALSE Error occurred.
This function is used to stop the generation of spool files and automatically close the spool file.
 
; 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.  
<PRE>
<PRE>
#define INCL_SPL
#define INCL_SPL
Line 35: Line 26:
</PRE>
</PRE>


==Example Code==
==Calling Sequence==
<PRE>
<PRE>
#define INCL_SPL /* Or use INCL_PM, */
#define INCL_SPL /* Or use INCL_PM, */
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);

Related Functions

Prerequisite Functions
SplQmOpen
Related Functions
DevEscape