PrintJobStatus enumeration

This enumeration is a one-to-one mapping to the spooler flags suppled in the JOB_INFO_X structures.

For example, JOB_INFO_1 has the same set of status flags as shown in the following list.

Syntax


typedef enum _PrintJobStatus { 
  PrintJobStatus_Paused              = 0x1,
  PrintJobStatus_Error               = 0x2,
  PrintJobStatus_Deleting            = 0x4,
  PrintJobStatus_Spooling            = 0x8,
  PrintJobStatus_Printing            = 0x10,
  PrintJobStatus_Offline             = 0x20,
  PrintJobStatus_PaperOut            = 0x40,
  PrintJobStatus_Printed             = 0x80,
  PrintJobStatus_Deleted             = 0x100,
  PrintJobStatus_BlockedDeviceQueue  = 0x200,
  PrintJobStatus_UserIntervention    = 0x400,
  PrintJobStatus_Restarted           = 0x800,
  PrintJobStatus_Complete            = 0x1000,
  PrintJobStatus_Retained            = 0x2000
} PrintJobStatus;

Constants

PrintJobStatus_Paused

The job is paused.

PrintJobStatus_Error

There is an error associated with the job.

PrintJobStatus_Deleting

The job is being deleted.

PrintJobStatus_Spooling

The job is spooling.

PrintJobStatus_Printing

The job is printing.

PrintJobStatus_Offline

The printer is offline.

PrintJobStatus_PaperOut

The printer is out of paper.

PrintJobStatus_Printed

The job printing is completed.

PrintJobStatus_Deleted

The job has been deleted.

PrintJobStatus_BlockedDeviceQueue

The driver cannot print the job.

PrintJobStatus_UserIntervention

The printer has an error that requires intervention from the user.

PrintJobStatus_Restarted

The job has been restarted.

PrintJobStatus_Complete

The job data transfer to the printer is complete. Note that the printing of the job may not yet be complete.

PrintJobStatus_Retained

The job has been retained in the print queue and cannot be deleted.

Remarks

A PrintJobStatus_Retained flag can be raised for several reasons. For example, jobs could be kept in the queue if the administrator of the queue used the desktop print queue UI to set the “Keep Printed Jobs” feature to be on.

It is possible for a job to have multiple flag values specified simultaneously.

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Header

Printerextension.h

See also

IPrintJob::Status
JOB_INFO_1

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft