PrinterStateReason element
The optional PrinterStateReason element specifies one piece of information about why the printer is in its current state.
PrinterStateReason is defined in the namespace at this URI: https://schemas.microsoft.com/windows/2005/05/wdp/print and referenced by the prefix wprt. (This resource may not be available in some languages and countries.)
Usage
<wprt:PrinterStateReason>
text
</wprt:PrinterStateReason>
Attributes
There are no attributes.
Text value
Required. Must be one of the following values:
AttentionRequired
The device has stopped for a reason other than one of the reasons listed here and requires human intervention before it can continue.
DoorOpen
One or more covers on the device are open.
MarkerFailure
The device has at least one marking device that has failed and requires service or replacement.
MarkerSupplyLow
The device is low on at least one marker supply, such as toner, ink, or ribbon.
MarkerSupplyEmpty
The device is out of at least one marker supply, such as toner, ink, or ribbon.
MediaEmpty
At least one input tray is empty.
MediaJam
The device has a media jam.
MediaLow
At least one input tray is low on media.
MediaNeeded
A submitted job has requested media that is currently not loaded. The job has specified a particular MediaSize and MediaType argument value combination that is not loaded, although the printer supports that combination.
None
Indicates that there are no current state reasons.
OutputAreaAlmostFull
One or more output area is almost full; for example, a tray, stacker, or collator.
OutputAreaFull
One or more output area is full; for example, a tray, stacker, or collator.
Paused
Someone has paused the printer and the printer state is Stopped. In this state, a printer will not produce printed output.
Child elements
There are no child elements.
Parent elements
| Element | Description |
|---|---|
|
A list of PrinterStateReason elements that describes the reasons why the printer is in its current state. |
Remarks
Some of these reasons describe printer state that cannot be entered on the basis of the currently defined WSD Print Service operation set. For example, the printer can be Paused even though there is no 'PausePrinter' operation. Such states are present because some other protocol or console action can have caused the printer to enter that state.
The Print Service must support the values that represent conditions that are detectable in its implementation. Therefore, a Print Service can support only that subset of allowed values that it can detect.
IHVs can extend the allowed values; however, there are implications of extending this list on a client. The client usually localizes the PrinterStateReasons value (as with other string variable values) to the human language of the user such that an IHV extension value will not be recognized by the client. As a fallback presentation, the client can display the value received as is, in English, and therefore, might not be understandable by all users. Alternatively, the Print Service can use the general AttentionRequired value and then explain the problem on the printer console.
See also
Send comments about this topic to Microsoft
Build date: 7/19/2012