Synchronous Events
The following synchronous events are supported in the PDF-XChange Drivers API:
•Event OnDocSpooled is fired immediately when the PDF-XChange Drivers API starts processing documents printed by the GDI.
•Event OnFileSaved is fired when documents are saved.
•Event OnFileSent is fired when automatic document emailing is enabled and the associated email has been sent.
•Event OnError is fired when an error occurs during document processing.
Event OnDocSpooled is fired immediately when the PDF-XChange Drivers API starts processing documents printed by the GDI.
Please note that all declarations and parameters are case-sensitive:
Declaration
C#
event OnDocSpooled(int JobID, string lpszDocName, string lpszAppName);
C++
HRESULT OnDocSpooled(LONG JobID, BSTR lpszDocName, BSTR lpszAppName);
VB
Event OnDocSpooled(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.
Please note that applications can set document-specific properties when this event is handled. (For example the path where documents are stored, as defined by the printing application).
Return Values
The application should return S_OK from this event handler.
Event OnFileSaved is fired when documents are saved. It enables the host application to perform application-based processing on documents as desired.
Declaration
C#
event OnFileSaved(int JobID, string lpszFileName);
C++
HRESULT OnFileSaved(LONG JobID, BSTR lpszFileName);
VB
Event OnFileSaved(JobID As Long, lpszFileName As String)
Parameters
JobID
Internal job identifier.
lpszFileName
Specifies the fully qualified path name where document were saved.
Return Values
The PDF-XChange Drivers API ignores values returned from this event.
EventOnFileSent is fired when automatic document emailing is enabled and the associated email has been sent.
Declaration
C#
event OnFileSent(int JobID, string lpszFileName);
C++
HRESULT OnFileSent(LONG JobID, BSTR lpszFileName);
VB
Event OnFileSent(JobID As Long, lpszFileName As String)
Parameters
Parameters for this event are the same as those of the OnFileSaved event detailed above.
Return Values
The PDF-XChange Drivers API ignores values returned from this event.
Event OnError is fired when an error occurs during document processing. Additionally, it means that events OnFileSaved and/or OnFileSent will not be fired and that processing of the document is terminated.
Declaration
C#
event OnError(int JobID, int dwErrorCode);
C++
HRESULT OnError(LONG JobID, LONG dwErrorCode);
VB
Event OnError(JobID As Long, dwErrorCode As Long)
Parameters
JobID
Internal job identifier.
dwErrorCode
Specifies an error (code) occurred during document processing.
Return Values
The PDF-XChange Drivers API ignores values returned from this event.