PrintQueueStream Class

Definition

Namespace:

System.Printing

Assembly:

System.Printing.dll

A stream that represents a spooled print job in a print queue.

public ref class PrintQueueStream : System::IO::Stream

public class PrintQueueStream : System.IO.Stream

type PrintQueueStream = class
    inherit Stream

Public Class PrintQueueStream
Inherits Stream

Inheritance

Object

Stream

PrintQueueStream

Remarks

Use this class 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 working with a Byte array, you can also use two of the overloads of the AddJob method and the JobStream property to write to the spool file.

Caution

Classes within the System.Printing namespace are not supported for use within a Windows service or ASP.NET application or service. Attempting to use these classes from within one of these application types may produce unexpected problems, such as diminished service performance and run-time exceptions.

If you want to print from a Windows Forms application, see the System.Drawing.Printing namespace.

Constructors

PrintQueueStream(PrintQueue, String, Boolean, PrintTicket)	Initializes a new instance of the PrintQueueStream class for the specified print job that is hosted in the specified PrintQueue, with the specified settings and an indication of whether data in the PrintQueueStream should be committed when the stream is closed.
PrintQueueStream(PrintQueue, String, Boolean)	Initializes a new instance of the PrintQueueStream class for the specified print job that is hosted in the specified PrintQueue, with an indication of whether data in the PrintQueueStream should be committed when the stream is closed.
PrintQueueStream(PrintQueue, String)	Initializes a new instance of the PrintQueueStream class for the specified print job that is hosted in the specified PrintQueue.

Properties

CanRead	Gets a value that indicates whether the stream supports reading.
CanSeek	Gets a value that indicates whether the stream supports seeking, which is moving the read/write position to a new position in the stream.
CanTimeout	Gets a value that determines whether the current stream can time out. (Inherited from Stream)
CanWrite	Gets a value that indicates whether the stream supports writing.
JobIdentifier	Gets the ID number of the print job.
Length	Gets the length of the stream in bytes.
Position	Gets or sets the current read/write position in the stream.
ReadTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream)
WriteTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream)

Methods

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Begins an asynchronous read operation. (Consider using ReadAsync(Byte[], Int32, Int32) instead.) (Inherited from Stream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Begins an asynchronous write operation.
Close()	Closes the stream and releases any resources, such as sockets and file handles, that are associated with it.
CopyTo(Stream, Int32)	Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyTo(Stream)	Reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream, Int32)	Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CopyToAsync(Stream)	Asynchronously reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream)
CreateWaitHandle()	Allocates a WaitHandle object. (Inherited from Stream)
Dispose()	Releases all resources used by the Stream. (Inherited from Stream)
Dispose(Boolean)	Releases the unmanaged resources that are used by the PrintQueueStream and optionally releases the managed resources.
DisposeAsync()	Asynchronously releases the unmanaged resources used by the Stream. (Inherited from Stream)
EndRead(IAsyncResult)	Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte[], Int32, Int32) instead.) (Inherited from Stream)
EndWrite(IAsyncResult)	Ends an asynchronous write operation.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize()	Enables a PrintQueueStream to attempt to free resources and perform other cleanup operations before the PrintQueueStream is reclaimed by garbage collection.
Flush()	Clears all the buffers for this stream and writes any buffered data to the underlying device.
FlushAsync()	Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream)
FlushAsync(CancellationToken)	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. (Inherited from Stream)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
HandlePackagingProgressEvent(Object, PackagingProgressEventArgs)	Enables the PrintQueueStream to respond to the packaging progress by handling the PackagingProgressEvent.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ObjectInvariant()	Provides support for a Contract. (Inherited from Stream)
Read(Byte[], Int32, Int32)	Reads a sequence of bytes from the stream and advances the read/write position in the stream by the number of bytes that were read.
Read(Span<Byte>)	When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream)
ReadAsync(Byte[], Int32, Int32)	Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream)
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream)
ReadAtLeast(Span<Byte>, Int32, Boolean)	Reads at least a minimum number of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronously reads at least a minimum number of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream)
ReadByte()	Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from Stream)
ReadExactly(Byte[], Int32, Int32)	Reads count number of bytes from the current stream and advances the position within the stream. (Inherited from Stream)
ReadExactly(Span<Byte>)	Reads bytes from the current stream and advances the position within the stream until the buffer is filled. (Inherited from Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously reads count number of bytes from the current stream, advances the position within the stream, and monitors cancellation requests. (Inherited from Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronously reads bytes from the current stream, advances the position within the stream until the buffer is filled, and monitors cancellation requests. (Inherited from Stream)
Seek(Int64, SeekOrigin)	Sets the read/write position within the stream.
SetLength(Int64)	Sets the length of the stream.
ToString()	Returns a string that represents the current object. (Inherited from Object)
Write(Byte[], Int32, Int32)	Writes a sequence of bytes to the stream and advances the read/write position in the stream by the number of bytes that are written.
Write(ReadOnlySpan<Byte>)	When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from Stream)
WriteAsync(Byte[], Int32, Int32)	Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from Stream)
WriteByte(Byte)	Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream)