Description
Each IPNJob object represents a single print job sent to any one of the printer queues in the current IPNSession object.
Most often there is a single print job created each for each document printed, but some applications can send multiple jobs when printing a single file. One example of this is Excel when printing a workbook containing multiple worksheets at different print quality settings. Excel will create a separate print job for each group of worksheets with different print qualities.
The job object is identified by a unique identifier, the JOBGUID and contains information about the job such as the job status and the number of pages spooled and printed. It also provides access to an IPNFiles collection of the files created by this job.
Breaking Changes
The following methods and properties have been removed as of PNSrvLib12.
•GetVariable, SetVariable
•GetVariableByKeyword, SetVariableByKeyword
•IPNPages collection
Properties
AbortedBySystem
Read-only; Boolean value True if the job was deleted by the system.
AbortedByUser
Read-only; Boolean value True if the job was deleted by the user.
BytesPrinted
Read-only; How much of the spooled document has been printed. This value is updated during the printing process.
BytesSpooled
Read-only; Size of the document (in bytes)in the printer queue. This value is updated as the file is spooled.
ConversionStatus
Read-only; Boolean value True if the job was successfully converted to the output file.
ConvertedPages
Read-only; The number of pages converted. Can be different from PagesPrinted.
ConvertedPagesSkipped
Read-only; Count of any pages skipped when the skip blank pages option is enabled.
Document
Read-only; Name of the document printed.
Files
Read-only; IPNFiles collection of IPNFile objects created by this print job. This value is updated during the printing process.
JobGUID
Read-only; Unique identifier for this object. Can be used to query the IPNJobs collection.
JobID
Read-only; non-unique identifier used by the Windows printing sub-system.
PagesPrinted
Read-only; count of the number of pages printed. This value is updated during the printing process.
PagesSpooled
Read-only; count of the number of pages spooled. This value is updated during the printing process.
PrintSessionGUID
Read-only; Unique identifier that can be used to associate this job with a print session.
Session
Read-only; The parent IPNSession object that created this IPNJob object.
Status
Read-only; current print status of the job as an Integer value. This value is updated during the printing process.
StatusMessage
Read-only; current print status of the job as an string value. This value is updated during the printing process.
SubmittedTime
Read-only; VT_DATE variant that specifies the time this document was spooled.
UserName
Read-only; name of the user who printed the document.
