ConsumableEntry element

Article
07/19/2012

The required ConsumableEntry element describes the details of an available consumable on the printer.

ConsumableEntry 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:ConsumableEntry
  Name = "xs:string"
  Removed = "xs:string">
  child elements
</wprt:ConsumableEntry>

Attributes

Attribute	Type	Required	Description
Name	xs:string	Yes	Required. Indicates the name associated with the current Consumables entry. This name should be unique within the device. May be any string.
Removed	xs:string	No	Optional. Indicates whether the consumable has been removed from the printer. If specified, must be one of: 0, 1, false, or true.

Name

xs:string

Yes

Required. Indicates the name associated with the current Consumables entry. This name should be unique within the device. May be any string.

Removed

xs:string

Optional. Indicates whether the consumable has been removed from the printer. If specified, must be one of: 0, 1, false, or true.

Text value

None

Child elements

Element	Description
Color	Indicates the color of the consumable associated with the current Consumables entry. This element is not applicable for some of the consumable types.
Level	Indicates the current level of consumable or media identified in the current ConsumableEntry, InputBinEntry, or OutputBinEntry element.
Model	Indicates the model name of the current Consumables entry. This can differentiate between versions of the same color or type of consumable, such as normal and high capacity cartridges.
Type	Indicates the type of consumable specified in ConsumableEntry, or the type of storage for the storage mechanism specified in StorageEntry.
Xxx	Any IHV-defined elements

Parent elements

Element	Description
Consumables	A collection of information that describes the consumables on the printer.

Consumables

A collection of information that describes the consumables on the printer.

Remarks

The Color attribute does not apply to all Type attributes, such as Developer. The WSD Print Service must set Color equal to Other for such attributes. IHVs can extend the allowed values for Type and Color.

The Removed attribute is valid only in a PrinterElementsChangeEvent event. It is used to report that the identified consumable has been removed from the printer. The absence of this attribute indicates that the consumable is still valid. The Removed attribute's default value is false.

The following syntax block shows that you must also prefix the names of the child elements with the appropriate namespace (in this case wprt), to be certain that you are referencing child elements in the correct namespace.

<wprt:ConsumableEntry Name="name" Removed="Boolean value">
 <wprt:Type> data </wprt:Type>
 <wprt:Color> data </wprt:Color>
  ...
</wprt:ConsumableEntry>

Share via