SplQmAbortDoc: Difference between revisions

Latest revision as of 22:06, 25 March 2020

SplQmAbortDoc ends a print job.

Syntax

rc = SplQmAbortDoc(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_STARTDOC_NOT_ISSUED (0x2104) A request to write spooled output without first issuing a STARTDOC was attempted.
PMERR_SPL_INV_HSPL (0x4005) The spooler handle is invalid.

Remarks

This function is used to end a print job. Everything that has been written to the spool file for this job since the last SplQmStartDoc is erased, including the SplQmStartDoc.

#define INCL_SPL
#include <OS2.H>

HSPL hspl; /* spooler handle. */

SplQmAbortDoc(hspl);

Related Functions

Prerequisite Functions: SplQmOpen; SplQmStartDoc
Related Functions: DevEscape

@@ Line 1: / Line 1: @@
 SplQmAbortDoc ends a print job.
 ==Syntax==
-  rc = SplQmAbortDoc(hspl);
+  rc = SplQmAbortDoc(hspl)
 ==Parameters==
-; hspl (HSPL) - input
+;hspl (HSPL) - input:Spooler handle.
-; Spooler handle.
 ==Return Code==
-; rc (BOOL) - returns
+;rc (BOOL) - returns:Success indicator.
-: Success indicator.
+* TRUE Successful completion
+* FALSE Error occurred.
-* TRUE Successful completion
-* FALSE Error occurred.
-; Error Conditions
+;Error Conditions: Possible returns from WinGetLastError
-: Possible returns from WinGetLastError
+* PMERR_SPL_QUEUE_ERROR (0x4004) No spooler queue supplied or found.
+* PMERR_STARTDOC_NOT_ISSUED (0x2104) A request to write spooled output without first issuing a STARTDOC was attempted.
-* PMERR_SPL_QUEUE_ERROR (0x4004)
+* PMERR_SPL_INV_HSPL (0x4005) The spooler handle is invalid.
-No spooler queue supplied or found.
-* PMERR_STARTDOC_NOT_ISSUED (0x2104)
-A request to write spooled output without first issuing a STARTDOC was attempted.
-* PMERR_SPL_INV_HSPL (0x4005)
-The spooler handle is invalid.
 ==Remarks==
 This function is used to end a print job. Everything that has been written to the spool file for this job since the last SplQmStartDoc is erased, including the SplQmStartDoc.
 <PRE>
 #define INCL_SPL
@@ Line 35: / Line 26: @@
 SplQmAbortDoc(hspl);
-</PRE>
-==Example Code==
-<PRE>
-#define INCL_SPL /* Or use INCL_PM, */
-#include <os2.h>
-HSPL    hspl;  /*  Spooler handle. */
-BOOL    rc;    /*  Success indicator. */
-rc = SplQmAbortDoc(hspl);
 </PRE>
 ==Related Functions==
-; Prerequisite Functions
+; Prerequisite Functions:[[SplQmOpen]]
-:[[SplQmOpen]]
+:[[SplQmStartDoc]]
-:[[SplQmStartDoc]]
+;Related Functions:[[DevEscape]]
-;Related Functions
-:[[DevEscape]]
 [[Category:Spl]]