JobStateReason element
The optional JobStateReason element specifies one reason why a job is in its current state.
JobStateReason is defined in the namespace at this URI: https://schemas.microsoft.com/windows/2006/08/wdp/print and referenced by the prefix wprt. (This resource may not be available in some languages and countries.)
Usage
<wprt:JobStateReason>
text
</wprt:JobStateReason>
Attributes
There are no attributes.
Text value
Required. Must be one of the following values:
CompressionError
An error occurred while attempting to decompress a document in the job.
DocumentAccessError
An error occurred while attempting to retrieve a document referenced in the job.
DocumentFormatError
An error occurred while attempting to interpret a document in the job.
JobCompletedSuccessfully
The job completed without any warnings or errors.
JobCompletedWithErrors
The job completed with at least one error. The type of error determines how much of the job is available in the output bin (for example, a Postscript stack overflow halfway through the job).
JobCompletedWithWarnings
The job completed with at least one warning. The job is expected to be available in the output bin. The warning may have altered the content; for example, a font substitution occurred.
JobIncoming
The job is currently being received by the printer.
JobPrinting
The printer is accessing, interpreting, transforming, rendering, marking, or applying a finishing to the job.
None
The job has no additional information on the job state.
PrinterStopped
The printer's state is stopped.
UnsupportedCompression
The job's document is compressed using an unsupported compression method.
UnsupportedDocumentFormat
The job's document contains an unsupported document format.
Any IHV-defined values
Child elements
There are no child elements.
Parent elements
| Element | Description |
|---|---|
|
Contains all additional information about why the job is in its current state. |
Remarks
The default value is "None".
IHVs must support the values that represent conditions that are detectable in their WSD Print Service implementation. IHVs can support only a subset of allowed values if specific job state reasons are undetectable in its implementation.
IHVs can extend the allowed values, with the understanding that extending this list has implications on the client. The client usually localizes the JobStateReasons value (as with other string variable values) to the human language of the user. A WSD Printer Service extension value will not be recognized by the client. As a fallback presentation, the client can display the value received as is. Typically, this value will be in English and, therefore, might not be understood by all users.
See also
Send comments about this topic to Microsoft
Build date: 7/19/2012