Jump to content

SplPdNewPage: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
No edit summary
Line 5: Line 5:


== Parameters ==
== Parameters ==
;hDevice (HFILE) - input:Handle from [[SplPdOpen]].
;''hDevice'' ([[HFILE]]) - input:Handle from [[SplPdOpen]].
;ulPageNumber (ULONG) - input:The new page number.
;''ulPageNumber'' ([[ULONG]]) - input:The new page number.


== Returns ==
== Returns ==
;rc (ULONG) - returns: Return codes.
;''rc'' ([[ULONG]]) - returns: Return codes.
*0 Success  
*0 Success  
*6 (ERROR_INVALID_HANDLE) : Invalid handle given.
*6 (ERROR_INVALID_HANDLE) : Invalid handle given.

Revision as of 04:26, 3 September 2025

SplPdNewPage is an API exported by port drivers. It is called by PrtNewPage to signal the beginning of a new output page. This call is issued for the first page in a job with page number 1, to signal the spooler that the port driver can determine print job page boundaries.

Syntax

SplPdNewPage(hDevice, ulPageNumber)

Parameters

hDevice (HFILE) - input
Handle from SplPdOpen.
ulPageNumber (ULONG) - input
The new page number.

Returns

rc (ULONG) - returns
Return codes.
  • 0 Success
  • 6 (ERROR_INVALID_HANDLE) : Invalid handle given.

Sample

#define INCL_SPL
#define INCL_SPLBIDI
#include <os2.h>

HFILE    hDevice;       /*  Handle from SplPdOpen. */
ULONG    ulPageNumber;  /*  The new page number. */
ULONG    rc;            /*  Return codes. */

rc = SplPdNewPage(hDevice, ulPageNumber);

Remarks

This call might not be issued for raw jobs. Some printer drivers might not be able to determine page breaks for raw print jobs.