Share via

PosPrinter.JrnCurrentCartridge Property

  • Article

2/27/2008

Gets or sets the currently selected journal cartridge.

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

Syntax

'Declaration
Public MustOverride Property JrnCurrentCartridge As PrinterColors

public abstract PrinterColors JrnCurrentCartridge { get; set; }

public:
virtual property PrinterColors JrnCurrentCartridge {
    PrinterColors get () abstract;
    void set (PrinterColors value) abstract;
}

/** @property */
public abstract PrinterColors get_JrnCurrentCartridge ()

/** @property */
public abstract void set_JrnCurrentCartridge (PrinterColors value)

public abstract function get JrnCurrentCartridge () : PrinterColors

public abstract function set JrnCurrentCartridge (value : PrinterColors)

Remarks

Possible values are defined by the PrinterColors enumeration.

JrnCurrentCartridge is set when the device is first enabled following the Open method. The application should set JrnCurrentCartridge based on the color in which it wants to print.

The value of JrnCurrentCartridge is must be one of the color cartridges specified by the CapJrnColor property. (JrnCurrentCartridge cannot be set to PrinterColors.Full.)

Setting JrnCurrentCartridge may also update the JrnCartridgeState property.

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

Value

Meaning

Illegal

One or more of the following conditions has occurred:

  • The CapJrnPresent property is set to false. This indicates that there is no journal station on this printer. In this case, JrnCurrentCartridge should be set to PrinterColors.None.

  • JrnCurrentCartridge was set to PrinterColors.None. However, the CapJrnPresent property is set to true. This indicates that a journal station is present.

  • JrnCurrentCartridge was either set to a value not found in the PrinterColors enumeration or set to PrinterColors.Full. Both are invalid.

  • JrnCurrentCartridge was set to a value not listed for the CapJrnColor property.

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.JrnCartridgeState Property
PosPrinter.CapJrnColor Property
PrinterColors