PrintQueueStream Class (System.Printing)

Switch View :
ScriptFree
.NET Framework Class Library
PrintQueueStream Class

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

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.Printing.PrintQueueStream

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

Visual Basic
Public Class PrintQueueStream _
	Inherits Stream
C#
public class PrintQueueStream : Stream
Visual C++
public ref class PrintQueueStream : public Stream
F#
type PrintQueueStream =  
    class
        inherit Stream
    end

The PrintQueueStream type exposes the following members.

Constructors

  Name Description
Public method PrintQueueStream(PrintQueue, String) Initializes a new instance of the PrintQueueStream class for the specified print job that is hosted in the specified PrintQueue.
Public method 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.
Top
Properties

  Name Description
Public property CanRead Gets a value that indicates whether the stream supports reading. (Overrides Stream.CanRead.)
Public property 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. (Overrides Stream.CanSeek.)
Public property CanTimeout Gets a value that determines whether the current stream can time out. (Inherited from Stream.)
Public property CanWrite Gets a value that indicates whether the stream supports writing. (Overrides Stream.CanWrite.)
Public property JobIdentifier Gets the ID number of the print job.
Public property Length Gets the length of the stream in bytes. (Overrides Stream.Length.)
Public property Position Gets or sets the current read/write position in the stream. (Overrides Stream.Position.)
Public property ReadTimeout Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
Public property WriteTimeout Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)
Top
Methods

  Name Description
Public method BeginRead Begins an asynchronous read operation. (Inherited from Stream.)
Public method BeginWrite Begins an asynchronous write operation. (Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)
Public method Close Closes the stream and releases any resources, such as sockets and file handles, that are associated with it. (Overrides Stream.Close().)
Public method CopyTo(Stream) Reads the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.)
Public method CopyTo(Stream, Int32) Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (Inherited from Stream.)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Protected method CreateWaitHandle Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
Public method Dispose() Releases all resources used by the Stream. (Inherited from Stream.)
Protected method Dispose(Boolean) Releases the unmanaged resources that are used by the PrintQueueStream and optionally releases the managed resources. (Overrides Stream.Dispose(Boolean).)
Public method EndRead Waits for the pending asynchronous read to complete. (Inherited from Stream.)
Public method EndWrite Ends an asynchronous write operation. (Overrides Stream.EndWrite(IAsyncResult).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Enables a PrintQueueStream to attempt to free resources and perform other cleanup operations before the PrintQueueStream is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public method Flush Clears all the buffers for this stream and writes any buffered data to the underlying device. (Overrides Stream.Flush().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HandlePackagingProgressEvent Enables the PrintQueueStream to respond to the packaging progress by handling the PackagingProgressEvent.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method ObjectInvariant Infrastructure. Provides support for a Contract. (Inherited from Stream.)
Public method Read 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. (Overrides Stream.Read(Byte[], Int32, Int32).)
Public method 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.)
Public method Seek Sets the read/write position within the stream. (Overrides Stream.Seek(Int64, SeekOrigin).)
Public method SetLength Sets the length of the stream. (Overrides Stream.SetLength(Int64).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Write 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. (Overrides Stream.Write(Byte[], Int32, Int32).)
Public method WriteByte Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream.)
Top
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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference