Tracker Software Products
Online Help System
Search:
Contents
IndexBookmarkPrint

Home >  > Word Template > Word Index

Asynchronous

Asynchronous Events

The following Asynchronous events are supported in PDF-XChange Driver 2012.

Event OnStartDoc

This event is fired when a new document starts to print.

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 as it was passed from the printing application.
lpszAppName
Specifies the module name of the printing application.

Return Value

PDF-XChange ignores returned values from this event.

 

Event OnStartPage

This event is fired for each page when it starts to print.

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 Value

PDF-XChange ignores returned values from this event.

 


Event OnEndPage

This event is fired for each page after printing completes.

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 Value

PDF-XChange ignores returned values from this event.

 


Event OnEndDoc

This event is fired when the complete document has been spooled by the GDI.

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
When this parameter is True, the document has fully spooled and PDF-XChange will continue to process this document to produce the PDF file. If there was an error during printing (e.g. printing cancelled) there will be no further document processing.

Return Value

PDF-XChange ignores returned values from this event.

 



See also


Was this information helpful?YesNo