Share via

PosPrinter.RecCartridgeState Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

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

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

Syntax

'Declaration
Public MustOverride ReadOnly Property RecCartridgeState As PrinterCartridgeStates

public abstract PrinterCartridgeStates RecCartridgeState { get; }

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

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

public abstract function get RecCartridgeState () : 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 CapRecCartridgeSensor property is set to PrinterCartridgeSensors.None. The Printer 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 RecCurrentCartridge property has been removed.

Empty

The cartridge specified by the RecCurrentCartridge property is empty.

Cleaning

The head specified by the RecCurrentCartridge property is being cleaned.

NearEnd

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

OK

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

Note

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

When RecCartridgeState is set to any value other than Unknown, POS for .NET queues a StatusUpdateEvent event, notifying the application of the change.

RecCartridgeState 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
RecCurrentCartridge
PosPrinter.CapRecCartridgeSensor Property
PosPrinter.CartridgeNotify Property
PrinterCartridgeStates