Share via

PosPrinter.SlpCartridgeState Property

  • Article

2/27/2008

Gets the status of the selected slip cartridge (ink, ribbon, or toner).

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride ReadOnly Property SlpCartridgeState As PrinterCartridgeStates

public abstract PrinterCartridgeStates SlpCartridgeState { get; }

public:
virtual property PrinterCartridgeStates SlpCartridgeState {
    PrinterCartridgeStates get () abstract;
}

/** @property */
public abstract PrinterCartridgeStates get_SlpCartridgeState ()

public abstract function get SlpCartridgeState () : PrinterCartridgeStates

Remarks

Possible values are defined by the PrinterCartridgeStates enumeration.

Values, listed in order of priority level, are as follows:

Value

Meaning

Unknown

Cannot determine the cartridge state, for one of the following reasons:

  • The CapSlpCartridgeSensor property is set to PrinterCartridgeSensors.None. The device does not support cartridge state reporting.

  • The CartridgeNotify property is set to PrinterCartridgeNotify.Disabled. Cartridge state notifications are disabled.

  • The DeviceEnabled property is set to false. Cartridge state monitoring does not occur until the device is enabled.

Removed

The cartridge specified by the SlpCurrentCartridge property has been removed.

Empty

The cartridge specified by the SlpCurrentCartridge property is empty.

Cleaning

The head specified by the SlpCurrentCartridge property is being cleaned.

NearEnd

The cartridge specified by the SlpCurrentCartridge property is near its end.

OK

The cartridge specified by the SlpCurrentCartridge property is in normal condition.

Note

These values are listed in priority order. The service object should set them in priority order also.

When SlpCartridgeState is set to any value other than PrinterCartridgeStates.Unknown, the service object queues a StatusUpdateEvent event by using the StatusSlip range of constants, notifying the application of the change.

SlpCartridgeState is set and kept current by the service object while the device is enabled.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PosPrinter Class
PosPrinter Members
Microsoft.PointOfService Namespace
SlpCurrentCartridge
PosPrinter.CapSlpCartridgeSensor Property
PosPrinter.CartridgeNotify Property
PosCommon.DeviceEnabled Property