Show / Hide Table of Contents

Class PrinterStatus

The PrinterStatus class represents status of a Star CloudPRNT Printer. Indivitual member properties can be inspected to check speficic status details.

Inheritance
System.Object
PrinterStatus
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: StarMicronics.CloudPrnt
Assembly: cs.temp.dll.dll
Syntax
public class PrinterStatus

Constructors

PrinterStatus(String)

Decode a cloudPRNT status string into a useful class.

Declaration
public PrinterStatus(string cpStatus)
Parameters
Type Name Description
System.String cpStatus

A string describing the device status in cloudPRNT format

Properties

BlackMarkError

Error when seaching for a registration black mark on paper

Declaration
public bool BlackMarkError { get; }
Property Value
Type Description
System.Boolean

CompulsionSwitch

Compulsion switch - returns state of a printer connected cash drawer or other RJ11 connected peripheral.

Declaration
public bool CompulsionSwitch { get; }
Property Value
Type Description
System.Boolean

CoverOpen

State of the printer codver, if true then the cover is open.

Declaration
public bool CoverOpen { get; }
Property Value
Type Description
System.Boolean

CutterError

True if an autocutter error has occured

Declaration
public bool CutterError { get; }
Property Value
Type Description
System.Boolean

MechanicalError

True if a mechanical, or thermistor error has occured

Declaration
public bool MechanicalError { get; }
Property Value
Type Description
System.Boolean

Online

Operating status of the printer: If true, then the printer is able to print, If false then the printer is in state which prevents printing.

Declaration
public bool Online { get; }
Property Value
Type Description
System.Boolean

OverTemperature

Returns true if the printer has stopped due to the print head exceeding correct operating temperature

Declaration
public bool OverTemperature { get; }
Property Value
Type Description
System.Boolean

PaperEmpty

True if the printer has run out of paper entirely

Declaration
public bool PaperEmpty { get; }
Property Value
Type Description
System.Boolean

PaperLow

True if the printer has reported that paper is near-end.

Declaration
public bool PaperLow { get; }
Property Value
Type Description
System.Boolean

PresenterPaperJam

True if paper has jammed in the presenter unit (if the device has a presenter unit fitted)

Declaration
public bool PresenterPaperJam { get; }
Property Value
Type Description
System.Boolean

ReceiveBufferOverflow

Indicate that the printer is error due to exceeding its data receive buffer without correct handshaking

Declaration
public bool ReceiveBufferOverflow { get; }
Property Value
Type Description
System.Boolean

Recoverable

True if the current error condition is automatically recoverable.

Declaration
public bool Recoverable { get; }
Property Value
Type Description
System.Boolean

VoltageError

True if the printer board has measured an incorrect voltage, indicating a power supply issue

Declaration
public bool VoltageError { get; }
Property Value
Type Description
System.Boolean

Methods

Equals(Object)

For test

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

For test

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
In This Article
Back to top