SplQmAbortDoc

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

No spooler queue supplied or found.
 * PMERR_SPL_QUEUE_ERROR (0x4004)

A request to write spooled output without first issuing a STARTDOC was attempted.
 * PMERR_STARTDOC_NOT_ISSUED (0x2104)

The spooler handle is invalid.
 * PMERR_SPL_INV_HSPL (0x4005)

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.


 * 1) define INCL_SPL
 * 2) include 

HSPL hspl; /* spooler handle. */

SplQmAbortDoc(hspl); 

Example Code

 * 1) define INCL_SPL /* Or use INCL_PM, */
 * 2) include 

HSPL   hspl;  /*  Spooler handle. */ BOOL   rc;    /*  Success indicator. */

rc = SplQmAbortDoc(hspl); 

Related Functions

 * Prerequisite Functions
 * SplQmOpen
 * SplQmStartDoc


 * Related Functions
 * DevEscape