Asynchronous Events
The following asynchronous events are supported in the PDF-XChange Drivers API:
•Event OnStartDoc is fired when printing starts for a new document.
•Event OnStartPage is fired when printing starts to for a new page.
•Event OnEndPage is fired when printing is complete for a page.
•Event OnEndDoc is fired when the GDI spools a complete document.
Event OnStartDoc is fired when printing starts for a new document.
Please note that all declarations and parameters are case-sensitive:
Declaration
C#
event OnStartDoc(int JobID, string lpszDocName, string lpszAppName);
C++
HRESULT OnStartDoc(LONG JobID, BSTR lpszDocName, BSTR lpszAppName);
VB
Event OnStartDoc(JobID As Long, lpszDocName As String, lpszAppName As String)
Parameters
JobID
Internal job identifier.
lpszDocName
Specifies the document name when passed from the printing application.
lpszAppName
Specifies the module name of the printing application.
Return Values
The PDF-XChange Drivers API ignores return values from this event.
Event OnStartPage is fired when printing starts for a new page.
Declaration
C#
event OnStartPage(int JobID, int nPageNumber);
C++
HRESULT OnStartPage(LONG JobID, LONG nPageNumber);
VB
Event OnStartPage(JobID As Long, nPageNumber As Long)
Parameters
JobID
Internal job identifier.
nPageNumber
Zero-based page number when spooling.
Return Values
The PDF-XChange Drivers API ignores return values from this event.
Event OnEndPage is fired when printing is complete for a page.
Declaration
C#
event OnEndPage(int JobID, int nPageNumber);
C++
HRESULT OnEndPage(LONG JobID, LONG nPageNumber);
VB
Event OnEndPage(JobID As Long, nPageNumber As Long)
Parameters
JobID
Internal job identifier.
nPageNumber
Zero-based page number spooled.
Return Values
The PDF-XChange Drivers API ignores return values from this event.
Event OnEndDoc is fired when the GDI spools a complete document.
Declaration
C#
event OnEndDoc(int JobID, int bOK);
C++
HRESULT OnEndDoc(LONG JobID, LONG bOK);
VB
Event OnEndDoc(JobID As Long, bOK As Long)
Parameters
JobID
Internal job identifier.
bOK
If this parameter is True then documents have fully spooled and the PDF-XChange Drivers API will continue processing and produce the files. If an error occurred during printing (such as the cancellation of the print job) then documents will not be processed further.
Return Values
The PDF-XChange Drivers API ignores return values from this event.