Tracker Software Products
Online Help System
Search:
Contents
IndexBookmarkPrint

Home >  >  > Orphaned Pages

Synchronous

Synchronous Events

The following Synchronous events are supported by the PDF-XChange 2012 Driver.

  • Event OnDocSpooled is fired immediately PDF-XChange starts processing the document printed by the GDI.
  • Event OnFileSaved is fired when the PDF file is saved.
  • Event OnFileSent is fired when PDF emailing is enabled and after the email has been sent. If emailing is not enabled this event will not fire.
  • Event OnError is fired if an error occurs during the processing of the PDF file.

Event OnDocSpooled

This event is fired immediately PDF-XChange begins processing the document printed by the GDI.

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

These event parameters are identical to the parameters for the OnStartDoc event.

During handling for this event the application can set document specific properties (for example, the path where the PDF document should be stored as defined by the printing application).

The application should return S_OK from this event handler.

 

Event OnFileSaved

This event is fired when the PDF file is saved. This allows the application to perform any application-based processing to this file.

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 for where the PDF document has been saved.

Return Value

PDF-XChange ignores returned values from this event.


 

Event OnFileSent

This event is fired when emailing of a PDF file is enabled and after the email has been sent. If emailing is not enabled, this event will not be fired.

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 the parameters for the OnFileSaved event. PDF-XChange ignores returned values from this event.


 

Event OnError

This event is fired when an error occurs during the processing of the PDF file. It further indicates that the events OnFileSaved and/or OnFileSent will not be fired for this document and 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 Value

PDF-XChange ignores the returned values from this event.



See also


Was this information helpful?YesNo