JobQueue

ProgID: PDFCreator.JobQueue

The queue collects all incoming print jobs and offers methods and properties to work with them appropriately. The following enumeration provides detailed information about these methods and properties.

void Initialize()

Summary: This is the first method you have to call after creating the COM Object in order to be able to use it.

bool WaitForJob(int timeOut)

Summary: The queue will wait for exactly one job to arrive within the timeOut.

timeOut: Integer defining the maximum time to wait in seconds.

Return value: True, if job arrived within the border time otherwise false.

bool WaitForJobs(int jobCount, int timeOut)

Summary: The queue will wait for arbitrary many jobs for timeOut seconds.

Parameter jobCount: Number of print jobs to wait for.

timeOut: Integer defining the maximum time to wait in seconds.

Return value: True, if job arrived within the border time otherwise false.

int Count

Summary: This property counts the current print jobs in the queue.

Return value: Number of print jobs in the queue.

PrintJob NextJob

Summary: Gives a reference to the next job in the queue as a PrintJob object

Return value: PrintJob object

PrintJob GetNextJobByIndex(int index)

Summary: Gives a reference to the job in the queue at position index as a PrintJob.

Return value: PrintJob object

void MergeAllJobs()

Summary: Merges all available jobs in the queue together to one print job.

void MergeJobs(PrintJob job1, PrintJob job2)

Summary: Merges two given jobs from the queue together to one print job.

job1: The first PrintJob to be merged.

job2: The second PrintJob to be merged with the first one.

void DeleteJob(int index)

Summary: Deletes a job from the queue, where the index determines the job to be deleted, i.e. given index 0 the first job will be deleted.

void ReleaseCom()

Summary: Releases your current COM object instance.

Note

If you should forget to call this method in the end it might happen that no other instance of PDFCreator or another COM instance will be able to run. Usually the reference will freed automatically when the script ends. If your script or application does further processing, it might take some time until the PDFCreator COM interface can be accessed again.