Share via

PosPrinterBase.CartridgeNotify Property

  • Article

2/27/2008

Holds the type of cartridge state notification the application wants to receive.

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

Syntax

'Declaration
Public Overrides Property CartridgeNotify As PrinterCartridgeNotify

public override PrinterCartridgeNotify CartridgeNotify { get; set; }

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

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

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

public override function get CartridgeNotify () : PrinterCartridgeNotify

public override function set CartridgeNotify (value : PrinterCartridgeNotify)

Remarks

PosPrinterBase class verifies that the device has been opened, then retrieves or sets the value of PosPrinterProperties.CartridgeNotify. If the application sets CartridgeNotify to an invalid PrinterCartridgeNotify value, PosPrinterProperties throws a PosControlException exception with ErrorCode set to ErrorCode.Illegal.

CartridgeNotify is initialized to PrinterCartridgeNotify.Disabled by the PosPrinterProperties class.

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

Value

Meaning

Illegal

  • CartridgeNotify can’t be set while the device is enabled;

  • CartridgeNotify was set to a value that isn’t 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

PosPrinterBase Class
PosPrinterBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
PosPrinter.CartridgeNotify Property
PrinterCartridgeNotify Enumeration