PrintQueueStatus Enumeration
TOC
Collapse the table of content
Expand the table of content

PrintQueueStatus Enumeration

 

Specifies the status of a print queue or its printer.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:   System.Printing
Assembly:  System.Printing (in System.Printing.dll)

[FlagsAttribute]
public enum PrintQueueStatus

Member nameDescription
Busy

The printer is busy.

DoorOpen

A door on the printer is open.

Error

The printer cannot print due to an error condition.

Initializing

The printer is initializing.

IOActive

The printer is exchanging data with the print server.

ManualFeed

The printer is waiting for a user to place print media in the manual feed bin.

None

Status is not specified.

NotAvailable

Status information is unavailable.

NoToner

The printer is out of toner.

Offline

The printer is offline.

OutOfMemory

The printer has no available memory.

OutputBinFull

The printer's output bin is full.

PagePunt

The printer is unable to print the current page.

PaperJam

The paper in the printer is jammed.

PaperOut

The printer does not have, or is out of, the type of paper needed for the current print job.

PaperProblem

The paper in the printer is causing an unspecified error condition.

Paused

The print queue is paused.

PendingDeletion

The print queue is deleting a print job.

PowerSave

The printer is in power save mode.

Printing

The device is printing.

Processing

The device is doing some kind of work, which need not be printing if the device is a combination printer, fax machine, and scanner.

ServerUnknown

The printer is in an error state.

TonerLow

Only a small amount of toner remains in the printer.

UserIntervention

The printer requires user action to correct an error condition.

Waiting

The printer is waiting for a print job.

WarmingUp

The printer is warming up.

Like the PrintQueue class, this enumeration handles the print queue and the physical printer (or device) as one unit. Some values represent the status of the physical device and others represent the status of the print queue program that is running on the print server.

Use this enumeration to provide values for the QueueStatus property of the PrintQueue class.

The following example shows how to use this enumeration as part of a survey all printers for possible error status.

// Check for possible trouble states of a printer using the flags of the QueueStatus property
internal static void SpotTroubleUsingQueueAttributes(ref String statusReport, PrintQueue pq)
{
    if ((pq.QueueStatus & PrintQueueStatus.PaperProblem) == PrintQueueStatus.PaperProblem)
    {
        statusReport = statusReport + "Has a paper problem. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.NoToner) == PrintQueueStatus.NoToner)
    {
        statusReport = statusReport + "Is out of toner. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.DoorOpen) == PrintQueueStatus.DoorOpen)
    {
        statusReport = statusReport + "Has an open door. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.Error) == PrintQueueStatus.Error)
    {
        statusReport = statusReport + "Is in an error state. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.NotAvailable) == PrintQueueStatus.NotAvailable)
    {
        statusReport = statusReport + "Is not available. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.Offline) == PrintQueueStatus.Offline)
    {
        statusReport = statusReport + "Is off line. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.OutOfMemory) == PrintQueueStatus.OutOfMemory)
    {
        statusReport = statusReport + "Is out of memory. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.PaperOut) == PrintQueueStatus.PaperOut)
    {
        statusReport = statusReport + "Is out of paper. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.OutputBinFull) == PrintQueueStatus.OutputBinFull)
    {
        statusReport = statusReport + "Has a full output bin. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.PaperJam) == PrintQueueStatus.PaperJam)
    {
        statusReport = statusReport + "Has a paper jam. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.Paused) == PrintQueueStatus.Paused)
    {
        statusReport = statusReport + "Is paused. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.TonerLow) == PrintQueueStatus.TonerLow)
    {
        statusReport = statusReport + "Is low on toner. ";
    }
    if ((pq.QueueStatus & PrintQueueStatus.UserIntervention) == PrintQueueStatus.UserIntervention)
    {
        statusReport = statusReport + "Needs user intervention. ";
    }

    // Check if queue is even available at this time of day
    // The method below is defined in the complete example.
    ReportAvailabilityAtThisTime(ref statusReport, pq);
}

.NET Framework
Available since 3.0
Return to top
Show:
© 2016 Microsoft