Sunday 26 February 2012

Accessing Printer Status using WinSpool in C#

 

After help from ambience I’ve managed to get the code working to access accurate printer status by using DllImport to access Winspool.drv (as opposed to using WMI, which had very mixed results).

There are 3 key functions you need to be aware of:

  • OpenPrinter
  • GetPrinter
  • ClosePrinter



The GetPrinter function is the one that does the real work we are interested in – accessing the PrinterInfo2 structure that gives you all the information you could possibly want on your named printer – driver, status, configuration, etc

Once you have the PrinterInfo2 you can than use bitwise operators along with known constants to find out the current status of the printer. One thing to note is that to detect whether a printer is marked as offline rather than physically offline you need to check the Attributes rather than Status – I’ll put a followup post shortly with details of a Helper class round the PrinterInfo2 status.

Here’s the code to help you out if, like me you need to get accurate printer info in C#:

//Code written by Mark Middlemist - @delradie 
//Made available at http://delradiesdev.blogspot.com
//Interop details from http://pinvoke.net/
using System;
using System.Runtime.InteropServices;

namespace DelradiesDev.PrinterStatus
{
  public class WinSpoolPrinterInfo
  {
    [DllImport("winspool.drv", CharSet = CharSet.Auto, SetLastError = true)]
    public static extern int OpenPrinter(string pPrinterName, out IntPtr phPrinter, ref PRINTER_DEFAULTS pDefault);
    
    [DllImport("winspool.drv", SetLastError = true, CharSet = CharSet.Auto)]
    public static extern bool GetPrinter(IntPtr hPrinter, Int32 dwLevel, IntPtr pPrinter, Int32 dwBuf, out Int32 dwNeeded);
    
    [DllImport("winspool.drv", SetLastError = true)]
    public static extern int ClosePrinter(IntPtr hPrinter);
        
    [StructLayout(LayoutKind.Sequential)]
    public struct PRINTER_DEFAULTS
    {
      public IntPtr pDatatype;
      public IntPtr pDevMode;
      public int DesiredAccess;
    }
    
    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Auto)]
    public struct PRINTER_INFO_2
    {
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pServerName;      
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pPrinterName;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pShareName;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pPortName;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pDriverName;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pComment;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pLocation;
      
      public IntPtr pDevMode;
      
      [MarshalAs(UnmanagedType.LPTStr)]      
      public string pSepFile;
      
      [MarshalAs(UnmanagedType.LPTStr)]      
      public string pPrintProcessor;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pDatatype;
      
      [MarshalAs(UnmanagedType.LPTStr)]
      public string pParameters;
      
      public IntPtr pSecurityDescriptor;
      public uint Attributes;
      public uint Priority;
      public uint DefaultPriority;
      public uint StartTime;
      public uint UntilTime;
      public uint Status;
      public uint cJobs;
      public uint AveragePPM;
    }
    
    public PRINTER_INFO_2? GetPrinterInfo(String printerName)
    {
      IntPtr pHandle;      
      PRINTER_DEFAULTS defaults = new PRINTER_DEFAULTS();      
      PRINTER_INFO_2? Info2 = null;
      
      OpenPrinter(printerName, out pHandle, ref defaults);
      
      Int32 cbNeeded = 0;
      
      bool bRet = GetPrinter(pHandle, 2, IntPtr.Zero, 0, out cbNeeded);
      
      if (cbNeeded > 0)
      {
        IntPtr pAddr = Marshal.AllocHGlobal((int)cbNeeded);
        
        bRet = GetPrinter(pHandle, 2, pAddr, cbNeeded, out cbNeeded);
        
        if (bRet)        
        {
          Info2 = (PRINTER_INFO_2)Marshal.PtrToStructure(pAddr, typeof(PRINTER_INFO_2));
        }
        
        Marshal.FreeHGlobal(pAddr);
      }
      
      ClosePrinter(pHandle);
      
      return Info2;
    }
  }
} 

3 comments:

  1. What a great post with nice details. Which kind of printer is using for printing the Metal business cards?

    ReplyDelete
  2. Why am i getting error at the PRINTER_INFO_2? ? It says expecting class, delegate, interface or delegate. What can I do? Thank you.

    ReplyDelete
  3. Status property showing as 0 always and hence cannot deduce the status of the printer.

    ReplyDelete