Classes Class XbpPrinter() :printerStatus()

Method XbpPrinter():printerStatus() Foundation

Determine the current status of a printer.

Syntax 
:printerStatus() --> nStatus
Return

The method returns a numeric value corresponding with one of the XBPPRN_STATUS_* constants listed in XBPDEV.CH:

#define constants for :printerStatus()
XBPPRN_STATUS_PAUSED
XBPPRN_STATUS_READY
XBPPRN_STATUS_BUSY
XBPPRN_STATUS_SERVICE
XBPPRN_STATUS_NOPAPER
XBPPRN_STATUS_NOT_READY
XBPPRN_STATUS_NA
XBPPRN_STATUS_ERROR
XBPPRN_STATUS_OFFLINE

XBPPRN_STATUS_PAUSED

The printer has been paused

XBPPRN_STATUS_READY

Printer is on-line and ready to print

XBPPRN_STATUS_BUSY

The printer is busy for one of the following reasons:

it is busy for unspecified reasons
low or no toner
output bin is full
status needs user intervention (unspecified)
paper track is jammed or has other problems
printer's door is currently open
printer is initializing or still warming up
printer could not be opened during ":create()"
OS-level printer object is currently being deleted
it has run out of memory
it cannot print the current/last page

XBPPRN_STATUS_SERVICE

The printer needs servicing or is currently being serviced due to:

Attribute: READONLY

XBPPRN_STATUS_NOPAPER

The printer is out of paper

XBPPRN_STATUS_NOT_READY

The printer is not (yet) ready to print due to:

Attribute: READONLY

XBPPRN_STATUS_NA

The printer is not available due to:

Attribute: READONLY

XBPPRN_STATUS_ERROR

Printer reports some error states such as:

Attribute: READONLY

XBPPRN_STATUS_OFFLINE

The printer is currently not on-line

Description

The return value of :printerStatus() is obtained from the operating system or the installed printer driver. If the method reports an unexpected status, it is recommended to update the printer driver to its newest version.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.