Share via

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

  • Article

2/27/2008

Gets or sets the type of cartridge state notification the application wants to receive.

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

Syntax

'Declaration
Public MustOverride Property CartridgeNotify As PrinterCartridgeNotify

public abstract PrinterCartridgeNotify CartridgeNotify { get; set; }

public:
virtual property PrinterCartridgeNotify CartridgeNotify {
    PrinterCartridgeNotify get () abstract;
    void set (PrinterCartridgeNotify value) abstract;
}

/** @property */
public abstract PrinterCartridgeNotify get_CartridgeNotify ()

/** @property */
public abstract void set_CartridgeNotify (PrinterCartridgeNotify value)

public abstract function get CartridgeNotify () : PrinterCartridgeNotify

public abstract function set CartridgeNotify (value : PrinterCartridgeNotify)

Remarks

Possible values are defined in the PrinterCartridgeNotify enumeration.

CartridgeNotify can only be set when the device is disabled—that is, when the DeviceEnabled property is set to false.

The application should set CartridgeNotify based on the type of cartridge state notification it wants to receive.

If the application sets CartridgeNotify to PrinterCartridgeNotify.Enabled, the service object raises cartridge state notification StatusUpdateEvent events and updates the JrnCartridgeState, RecCartridgeState, and SlpCartidgeState properties, beginning when the DeviceEnabled property is set to true. The level of functionality depends on the values of the CapJrnCartridgeSensor, CapRecCartridgeSensor, and CapSlpCartridgeSensor properties.

If the application sets CartridgeNotify to PrinterCartridgeNotify.Disabled, no cartridge state notification StatusUpdateEvent events will be raised, and the JrnCartridgeState, RecCartridgeState, and SlpCartidgeState properties may not be set.

Accessing CartridgeNotify may cause a PosControlException to be thrown with the following ErrorCode:

Value

Meaning

Illegal

One of the following conditions occurred:

  • CartridgeNotify cannot be set while the device is enabled;

  • CartridgeNotify was set to a value that is not valid for the PrinterCartridgeNotify enumeration; or

  • CartridgeNotify is set to PrinterCartridgeNotify.Enabled but the CapJrnCartridgeSensor, CapRecCartridgeSensor, and CapSlpCartridgeSensor properties are set to PrinterCartridgeSensors.None.

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
PosPrinter.CapJrnCartridgeSensor Property
PosPrinter.CapRecCartridgeSensor Property
PosPrinter.CapSlpCartridgeSensor Property
JrnCartridgeState
RecCartridgeState
SlpCartridgeState
PrinterCartridgeNotify
PrinterCartridgeSensors
PosCommon.DeviceEnabled Property