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
PowerSaveThe printer is in power save mode.
ServerUnknownThe printer is in an error state.
DoorOpenA door on the printer is open.
OutOfMemoryThe printer has no available memory.
UserInterventionThe printer requires user action to correct an error condition.
PagePuntThe printer is unable to print the current page.
NoTonerThe printer is out of toner.
TonerLowOnly a small amount of toner remains in the printer.
WarmingUpThe printer is warming up.
InitializingThe printer is initializing.
ProcessingThe device is doing some kind of work, which need not be printing if the device is a combination printer, fax machine, and scanner.
WaitingThe printer is waiting for a print job.
NotAvailableStatus information is unavailable.
OutputBinFullThe printer's output bin is full.
BusyThe printer is busy.
IOActiveThe printer is exchanging data with the print server.
OfflineThe printer is offline.
PaperProblemThe paper in the printer is causing an unspecified error condition.
ManualFeedThe printer is waiting for a user to place print media in the manual feed bin.
PaperOutThe printer does not have, or is out of, the type of paper needed for the current print job.
PaperJamThe paper in the printer is jammed.
PendingDeletionThe print queue is deleting a print job.
PausedThe print queue is paused.
NoneStatus is not specified.
PrintingThe device is printing.
ErrorThe printer cannot print due to an error condition.

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

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2016 Microsoft