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

  • Article

2/27/2008

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

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

Syntax

'Declaration
Public Overrides ReadOnly Property RecCartridgeState As PrinterCartridgeStates

public override PrinterCartridgeStates RecCartridgeState { get; }

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

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

public override function get RecCartridgeState () : PrinterCartridgeStates

Remarks

PosPrinterBase class verifies that the device has been opened, claimed, and enabled, then retrieves the value of PosPrinterProperties.RecCartridgeState. If CapRecCartridgeSensor is set to PrinterCartridgeSensors.None, or if CartridgeNotify is set to PrinterCartridgeNotify.Disabled, RecCartridgeState returns a value of PrinterCartridgeStates.Unknown.

RecCartridgeState is initialized to PrinterCartridgeStates.OK by the PosPrinterProperties class and should be kept current by the service object while the printer device is enabled.

POS for .NET may throw PosControlException exceptions under the following conditions, with the specified ErrorCodes:

Value

Meaning

Illegal

The service object has set the RecCartridgeState property to an invalid PrinterCartridgeStates value.

If the CartridgeNotify property is set to PrinterCartridgeNotify.Enabled and the value of RecCartridgeState changes, the PosPrinterProperties class queues the appropriate StatusUpdateEvent event, notifying the application of the change.

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

PosPrinterBase Class
PosPrinterBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
PosPrinter.RecCartridgeState Property