SplQmClose: Difference between revisions

Latest revision as of 20:15, 2 July 2023

SplQmClose closes the spool file. It corresponds to the DevCloseDC function.

Syntax

rc = SplQmClose(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_ENDDOC_NOT_ISSUED (0x210B) A request to close the spooled output without first issuing a an ENDDOC was attempted.
PMERR_SPL_INV_HSPL (0x4005) The spooler handle is invalid.

Remarks

This function is used to close a spool file that was opened with SplQmOpen.

#define INCL_SPL
#include <OS2.H>

HSPL hspl; /* spooler handle. */

SplQmClose(hspl);

Example Code

#define INCL_SPL /* Or use INCL_PM, */
#include <os2.h>

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

rc = SplQmClose(hspl);

Related Functions

Prerequisite Functions: SplQmOpen
Related Functions: DevCloseDC

@@ Line 1: / Line 1: @@
 SplQmClose closes the spool file. It corresponds to the DevCloseDC function.
 ==Syntax==
-  rc = SplQmClose(hspl);
+  rc = SplQmClose(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
+; Error Conditions: Possible returns from WinGetLastError
-* FALSE Error occurred.
-; Error Conditions: Possible returns from WinGetLastError
+* PMERR_SPL_QUEUE_ERROR (0x4004) No spooler queue supplied or found.
+* PMERR_ENDDOC_NOT_ISSUED (0x210B) A request to close the spooled output without first issuing a an ENDDOC was attempted.
-* PMERR_SPL_QUEUE_ERROR (0x4004)
+* PMERR_SPL_INV_HSPL (0x4005) The spooler handle is invalid.
-No spooler queue supplied or found.
-* PMERR_ENDDOC_NOT_ISSUED (0x210B)
-A request to close the spooled output without first issuing a an ENDDOC was attempted.
-* PMERR_SPL_INV_HSPL (0x4005)
-The spooler handle is invalid.
 ==Remarks==
 This function is used to close a spool file that was opened with SplQmOpen.
 <PRE>
 #define INCL_SPL
@@ Line 50: / Line 43: @@
 ; Prerequisite Functions :[[SplQmOpen]]
 ; Related Functions: [[DevCloseDC]]
 [[Category:Spl]]