Click here to Skip to main content
Click here to Skip to main content

Monitor jobs in a printer queue (.NET)

, 7 Jan 2010
Rate this:
Please Sign up or sign in to vote.
This article demonstrates monitoring a printer queue for job status changes.

Introduction

This article demonstrates the ability to monitor a print queue on the local machine.

Background

There is a lot of code available in the internet (CodeProject as well as other sites) about the API calls to do print spool monitoring. However, I was not able to find any code that would help the user to enable monitoring one or more print queues with minimal code changes. So, I created a class (PrintQueueMonitor) that would allow the user to monitor the print queue for job changes and raise an event as and when jobs get added to the queue or job status gets changed in the queue.

Using the code

The attached zip file contains two projects:

  1. PrintQueueMonitor
  2. PrintSpooler

The PrintQueueMonitor project has two main files:

  • PrintSpoolAPI.cs
  • PrintQueueMonitor.cs

PrintSpoolAPI.cs contains the data types and structures used by PrintQueueMonitor. This API was not created by me, and I pulled this from the internet (not sure of the location):

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Runtime.InteropServices;
using System.Globalization;
namespace Atom8.API.PrintSpool
{
    public enum JOBCONTROL
    ......
    ......
}

PrintQueueMonitor.cs contains two classes - PrintJobChangeEventArgs and PrintQueueMonitor, and a delegate PrintJobStatusChanged.

The PrintJobChangeEventArgs is inherited from EventArgs. This object is passed while raising the event for job status addition or change in status or deletion.

public class PrintJobChangeEventArgs : EventArgs
{
    #region private variables
    private int _jobID=0;
    private string _jobName = "";
    private JOBSTATUS _jobStatus = new JOBSTATUS();
    private PrintSystemJobInfo _jobInfo = null;
    #endregion
    public int JobID { get { return _jobID;}  }
    public string JobName { get { return _jobName; } }
    public JOBSTATUS JobStatus { get { return _jobStatus; } }
    public PrintSystemJobInfo JobInfo { get { return _jobInfo; } }
    public PrintJobChangeEventArgs(int intJobID, string strJobName, 
           JOBSTATUS jStatus, PrintSystemJobInfo objJobInfo )
        : base()
    {
        _jobID = intJobID;
        _jobName = strJobName;
        _jobStatus = jStatus;
        _jobInfo = objJobInfo;
    }
}

The delegate PrintJobStatusChanged is the type of event raised when the PrintQueueMonitor class needs to send job status change notifications to the owner.

public delegate void PrintJobStatusChanged(object Sender, 
                     PrintJobChangeEventArgs e);

The PrintQueueMonitor class imports Win32 API functions, registers with the Win32 Spooler for change notifications, and waits for notificaitons. Upon receipt of notification, it checks to see if the notification is relevant to a job, and if so, raises the OnJobStatusChange() event with the appropriate parameters:

public class PrintQueueMonitor  
{
    #region DLL Import Functions
    [DllImport("winspool.drv", 
      EntryPoint = "OpenPrinterA",SetLastError = true, 
      CharSet = CharSet.Ansi,ExactSpelling = true, 
      CallingConvention = CallingConvention.StdCall)]
    public static extern bool OpenPrinter(String pPrinterName,
    out IntPtr phPrinter,
    Int32 pDefault);
    [DllImport("winspool.drv", 
        EntryPoint = "ClosePrinter",
        SetLastError = true,
        ExactSpelling = true,
        CallingConvention = CallingConvention.StdCall)]
    public static extern bool ClosePrinter
    (Int32 hPrinter);
    [DllImport("winspool.drv",
    EntryPoint = "FindFirstPrinterChangeNotification",
    SetLastError = true, CharSet = CharSet.Ansi,
    ExactSpelling = true,
    CallingConvention = CallingConvention.StdCall)]
    public static extern IntPtr FindFirstPrinterChangeNotification
                        ([InAttribute()] IntPtr hPrinter,
                        [InAttribute()] Int32 fwFlags,
                        [InAttribute()] Int32 fwOptions,
                        [InAttribute(), 
                         MarshalAs(UnmanagedType.LPStruct)] 
                         PRINTER_NOTIFY_OPTIONS pPrinterNotifyOptions);
    [DllImport("winspool.drv", EntryPoint = 
               "FindNextPrinterChangeNotification",
    SetLastError = true, CharSet = CharSet.Ansi,
    ExactSpelling = false,
    CallingConvention = CallingConvention.StdCall)]
    public static extern bool FindNextPrinterChangeNotification
                        ([InAttribute()] IntPtr hChangeObject,
                         [OutAttribute()] out Int32 pdwChange,
                         [InAttribute(), 
                          MarshalAs(UnmanagedType.LPStruct)] 
                          PRINTER_NOTIFY_OPTIONS pPrinterNotifyOptions,
                        [OutAttribute()] out IntPtr lppPrinterNotifyInfo
                             );
        #endregion
        #region Constants
        const int PRINTER_NOTIFY_OPTIONS_REFRESH = 1;
        #endregion
        #region Events
        public event PrintJobStatusChanged OnJobStatusChange;
        #endregion
        #region private variables
        private IntPtr _printerHandle = IntPtr.Zero;
        private string _spoolerName = "";
        private ManualResetEvent _mrEvent = new ManualResetEvent(false);
        private RegisteredWaitHandle _waitHandle = null;
        private IntPtr _changeHandle = IntPtr.Zero;
        private PRINTER_NOTIFY_OPTIONS _notifyOptions = 
                new PRINTER_NOTIFY_OPTIONS();
        private Dictionary<int, string> objJobDict = 
                new Dictionary<int, string>();
        private PrintQueue _spooler = null;
        #endregion
        #region constructor
        public PrintQueueMonitor(string strSpoolName) 
        {
            // Let us open the printer and get the printer handle.
            _spoolerName = strSpoolName;
            //Start Monitoring
            Start();
        }
        #endregion
        #region destructor
        ~PrintQueueMonitor() 
        {
            Stop();
        }
        #endregion
        #region StartMonitoring
        public void Start()
        {
            OpenPrinter(_spoolerName, out _printerHandle, 0);
            if (_printerHandle != IntPtr.Zero)
            {
                //We got a valid Printer handle. 
                //Let us register for change notification....
                _changeHandle = FindFirstPrinterChangeNotification(
                  _printerHandle, (int)PRINTER_CHANGES.PRINTER_CHANGE_JOB, 0, 
                  _notifyOptions);
                // We have successfully registered for change
                // notification. Let us capture the handle...
                _mrEvent.Handle = _changeHandle;
                //Now, let us wait for change notification from the printer queue....
                _waitHandle = ThreadPool.RegisterWaitForSingleObject(_mrEvent, 
                  new WaitOrTimerCallback(PrinterNotifyWaitCallback), 
                  _mrEvent, -1, true);
            }
            _spooler = new PrintQueue(new PrintServer(), _spoolerName);
            foreach (PrintSystemJobInfo psi in _spooler.GetPrintJobInfoCollection())
            {
                objJobDict[psi.JobIdentifier] = psi.Name;
            }
        }
        #endregion
        #region StopMonitoring
        public void Stop()
        {
            if (_printerHandle != IntPtr.Zero)
            {
                ClosePrinter((int)_printerHandle);
                _printerHandle = IntPtr.Zero;
            }
        }
        #endregion
        #region Callback Function
        public void PrinterNotifyWaitCallback(Object state,bool timedOut)
        {
            if (_printerHandle == IntPtr.Zero) return;
            #region read notification details
            _notifyOptions.Count = 1;
            int pdwChange = 0;
            IntPtr pNotifyInfo = IntPtr.Zero;
            bool bResult = FindNextPrinterChangeNotification(_changeHandle, 
                           out pdwChange, _notifyOptions, out pNotifyInfo);
            //If the Printer Change Notification Call did not give data, exit code
            if ((bResult == false) || (((int)pNotifyInfo) == 0)) return;
            //If the Change Notification was not relgated to job, exit code
            bool bJobRelatedChange = 
              ((pdwChange & PRINTER_CHANGES.PRINTER_CHANGE_ADD_JOB) == 
                PRINTER_CHANGES.PRINTER_CHANGE_ADD_JOB) || 
              ((pdwChange & PRINTER_CHANGES.PRINTER_CHANGE_SET_JOB) == 
                PRINTER_CHANGES.PRINTER_CHANGE_SET_JOB) ||
              ((pdwChange & PRINTER_CHANGES.PRINTER_CHANGE_DELETE_JOB) == 
                PRINTER_CHANGES.PRINTER_CHANGE_DELETE_JOB) ||
              ((pdwChange & PRINTER_CHANGES.PRINTER_CHANGE_WRITE_JOB) == 
                PRINTER_CHANGES.PRINTER_CHANGE_WRITE_JOB);
            if (!bJobRelatedChange) return;
            #endregion 
            #region populate Notification Information
            //Now, let us initialize and populate the Notify Info data
            PRINTER_NOTIFY_INFO info = 
              (PRINTER_NOTIFY_INFO)Marshal.PtrToStructure(pNotifyInfo, 
               typeof(PRINTER_NOTIFY_INFO));                        
            int pData = (int)pNotifyInfo + 
                         Marshal.SizeOf(typeof(PRINTER_NOTIFY_INFO));
            PRINTER_NOTIFY_INFO_DATA[] data = 
                    new PRINTER_NOTIFY_INFO_DATA[info.Count];
            for (uint i = 0; i < info.Count; i++)
            {
                data[i] = (PRINTER_NOTIFY_INFO_DATA)Marshal.PtrToStructure(
                          (IntPtr)pData, typeof(PRINTER_NOTIFY_INFO_DATA));
                pData += Marshal.SizeOf(typeof(PRINTER_NOTIFY_INFO_DATA));
            }
            #endregion 
            
            #region iterate through all elements in the data array
            for (int i = 0; i < data.Count(); i++)
            {
                if ( (data[i].Field == 
                       (ushort)PRINTERJOBNOTIFICATIONTYPES.JOB_NOTIFY_FIELD_STATUS) &&
                     (data[i].Type == (ushort)PRINTERNOTIFICATIONTYPES.JOB_NOTIFY_TYPE)
                    )
                {
                   JOBSTATUS jStatus  = (JOBSTATUS)Enum.Parse(typeof(JOBSTATUS), 
                                         data[i].NotifyData.Data.cbBuf.ToString());
                    int intJobID = (int)data[i].Id;
                    string strJobName = ""; 
                    PrintSystemJobInfo pji = null;
                    try
                    {
                        _spooler = new PrintQueue(new PrintServer(), _spoolerName);
                        pji = _spooler.GetJob(intJobID);
                        if (!objJobDict.ContainsKey(intJobID))
                            objJobDict[intJobID] = pji.Name;
                        strJobName = pji.Name;
                    }
                    catch
                    {
                        pji = null;
                        objJobDict.TryGetValue(intJobID, out strJobName);
                        if (strJobName == null) strJobName = "";
                    }
                    if (OnJobStatusChange != null)
                    {
                        //Let us raise the event
                        OnJobStatusChange(this, 
                          new PrintJobChangeEventArgs(intJobID,strJobName,jStatus,pji));
                    }
                }
            }
            #endregion
            #region reset the Event and wait for the next event
            _mrEvent.Reset();
            _waitHandle = ThreadPool.RegisterWaitForSingleObject(_mrEvent, 
              new WaitOrTimerCallback(PrinterNotifyWaitCallback), _mrEvent, -1, true);
            #endregion 
        }
        #endregion
    }

Sample source code and usage

The PrintSpooler project is a sample (with code) that uses the PrintQueueMonitor class and appends a list box with job change notifications received from the PrintQueueMonitor class.

pqm = new PrintQueueMonitor(cmbPrinters.Text.Trim());
pqm.OnJobStatusChange += 
    new PrintJobStatusChanged(pqm_OnJobStatusChange);
........
........
........

void pqm_OnJobStatusChange(object Sender, PrintJobChangeEventArgs e)
{

    MethodInvoker invoker = () => {
        lbSpoolChanges.Items.Add(e.JobID + " - " + 
        e.JobName + " - " + e.JobStatus);
    };

    if (lbSpoolChanges.InvokeRequired)
        Invoke(invoker);
    else
        invoker();
}

History

To build this class and sample, I have used pieces of code from various posts from CodeProject and other sites. Many thanks to the individuals who have contributed to this.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

raelango
Architect Atom8 IT Solutions (P) Ltd
India India
I have been programming since 1991. I consider programming as my passion. I founded Atom8 IT Solutions (P) Ltd., in April 2009 and have been developing applications in Microsoft Technologies (mainly C#, Silverlight).
 
My specialization has been on the US healthcare domain (Medical Transcription, Patient Financial Services, EMRs).

Comments and Discussions

 
QuestionGet Job Info PinmemberMohammad Al-Akhras12-Apr-14 12:05 
AnswerRe: Get Job Info Pinmemberbsopik14-Jul-14 23:11 
GeneralRe: Get Job Info PinmemberMohammad Al-Akhras15-Jul-14 14:56 
Questiontotal page count PinmemberMember 104219491-Dec-13 19:47 
Questionpagetotal Pinmembersaeed13646-Nov-13 3:09 
AnswerRe: pagetotal PinmemberMember 104219491-Dec-13 19:53 
QuestionNetwork Printer compatibility? Pinmembervenkatesun27-Aug-13 4:16 
AnswerRe: Network Printer compatibility? Pinmembervenkatesun29-Aug-13 4:01 
AnswerRe: Network Printer compatibility? PinmemberJAE728-Sep-13 18:45 
GeneralRe: Network Printer compatibility? Pinmembervenkatesun13-Sep-13 5:08 
GeneralRe: Network Printer compatibility? PinmemberJAE7215-Sep-13 13:36 
GeneralRe: Network Printer compatibility? PinmemberJAE7217-Sep-13 17:04 
GeneralRe: Network Printer compatibility? PinmemberMember 102842488-May-14 18:07 
QuestionChange username PinmemberMember 835129527-Jun-13 5:52 
QuestionCompatibility! PinmembersagarDuwal12-May-13 3:00 
QuestionSEHException when closing the project Pinmembersskorokh14-Apr-13 21:53 
QuestionUsername and number of pages PinmemberMember 985668515-Mar-13 0:50 
QuestionSolution for problems with Windows7 x64 Pinmemberpawsie24-Jan-13 0:08 
QuestionNotification problem with network printer Pinmembersoldasnik1-Oct-12 4:18 
AnswerRe: Notification problem with network printer Pinmembervenkatesun29-Aug-13 4:02 
QuestionCan the same thing can be done in MFC Pinmemberpradeep_done119-Sep-12 15:53 
Questionwe found a solution to solve the problem at Windows2008 R2 x64 platform Pinmemberweng_yeung3-Jun-12 22:49 
Questionhow do read the contents of the file which is being printed Pinmembermujahidcodeproject14-May-12 22:21 
QuestionIOException was unhandled Pinmemberursixc927-Jan-12 5:41 
QuestionNumberofPages Printed PinmemberPrabhu Rajendran26-Jan-12 4:00 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web03 | 2.8.140814.1 | Last Updated 8 Jan 2010
Article Copyright 2010 by raelango
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid