Export (0) Print
Expand All

PrintQueue.AddJob Method

Inserts a new (generically named) print job, whose content is a Byte array, into the queue.

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

'Declaration
Public Function AddJob As PrintSystemJobInfo

Return Value

Type: System.Printing.PrintSystemJobInfo
A PrintSystemJobInfo that represents the print job and its status.

Use this method to write device specific information, to a spool file, that is not automatically included by the Microsoft Windows spooler. Of course, you need to know whether the spool file is Enhanced Metafile (EMF) or XML Paper Specification (XPS). If you prefer to work with the Stream API, you can use the PrintQueueStream class instead of this method.

After the AddJob method has been called, you must write a Byte array to the JobStream property of the PrintSystemJobInfo that is returned by AddJob or no print job is created. This array is what prints if the printer is working and is not paused.

Caution noteCaution

If the JobStream is not closed with Close before the end of the thread in which AddJob is called, then an InvalidOperationException is thrown when that thread ends because the spooler thread cannot gain control over the Stream object.

In the print queue's graphical user interface (GUI), the job has the name "Print System Document". To give the job a different name, use the AddJob(String) overload.

Other ways to print in Windows Presentation Foundation (WPF) include the PrintDialog.PrintDocument method, which can be used with or without opening the dialog, and the many Write and WriteAsync methods of the XpsDocumentWriter.

The following example shows how to use AddJob to send a Byte array to a print queue. This code only works with printers that can detect and print plain text. Some of them cannot.

			' Create the printer server and print queue objects
			Dim localPrintServer As New LocalPrintServer()
			Dim defaultPrintQueue As PrintQueue = LocalPrintServer.GetDefaultPrintQueue()

			' Call AddJob
			Dim myPrintJob As PrintSystemJobInfo = defaultPrintQueue.AddJob()

			' Write a Byte buffer to the JobStream and close the stream
			Dim myStream As Stream = myPrintJob.JobStream
			Dim myByteBuffer() As Byte = UnicodeEncoding.Unicode.GetBytes("This is a test string for the print job stream.")
			myStream.Write(myByteBuffer, 0, myByteBuffer.Length)
			myStream.Close()

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft