PrinterStatusSummaryEvent element

Article
07/19/2012

The required PrinterStatusSummaryEvent element informs the client that the printer's status has changed.

PrinterStatusSummaryEvent 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:PrinterStatusSummaryEvent>
  child elements
</wprt:PrinterStatusSummaryEvent>

Attributes

There are no attributes.

Text value

None

Child elements

Element	Description
StatusSummary	Contains a summary of the printer's current status.

StatusSummary

Contains a summary of the printer's current status.

Parent elements

There are no parent elements.

Remarks

The WSD Print Service should send a PrinterStatusSummaryEvent element to the client when the printer's status has changed.

The body of PrinterStatusSummaryEvent must contain a StatusSummary element that describes the changes to the printer's status.

In the following example code, note that you must also prefix the names of the child and other elements with the appropriate namespace, to be certain that your name references apply to elements in the correct namespace.

Examples

The following code sample shows that the device is in a user intervention error state because it is out of paper in a paper tray. One of its consumables is also low, but that is secondary to the MediaNeeded condition:

<soap:Envelope
    xmlns:soap="https://www.w3.org/2003/05/soap-envelope"
    xmlns:wsa="https://schemas.xmlsoap.org/ws/2004/08/addressing"
    xmlns:wse="https://schemas.xmlsoap.org/ws/2004/08/eventing"
    xmlns:wprt="https://schemas.microsoft.com/windows/2005/05/wdp/print">
    soap:encodingStyle='https://www.w3.org/2002/12/soap-encoding' >
  <soap:Header>
    <wsa:To>AddressofEventSink</wsa:To>
    <wsa:Action>
      https://schemas.microsoft.com/windows/2005/05/wdp/print/PrinterStatusSummaryEvent
    </wsa:Action>
    <wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
  </soap:Header>
  <soap:Body>
    <wprt:PrinterStatusSummaryEvent>
      <wprt:StatusSummary>
        <wprt:PrinterState>Stopped</wprt:PrinterState>
        <wprt:PrinterPrimaryStateReason>MediaNeeded</wprt:PrinterPrimaryStateReason>
        <wprt:PrinterStateReasons>
          <wprt:PrinterStateReason>MarkerSupplyLow</wprt:PrinterStateReason>
          <wprt:PrinterStateReason>MediaNeeded</wprt:PrinterStateReason>
        </wprt:PrinterStateReasons>
      </wprt:StatusSummary>
    </wprt:PrinterStatusSummaryEvent>
  </soap:Body
</soap:Envelope>

Share via