LocalPrintServer Class (System.Printing)

Switch View :
ScriptFree
.NET Framework Class Library
LocalPrintServer Class

Represents the local print server (the computer on which your application is running) and enables management of its print queues.

Inheritance Hierarchy

System.Object
  System.Printing.PrintSystemObject
    System.Printing.PrintServer
      System.Printing.LocalPrintServer

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

Visual Basic
Public NotInheritable Class LocalPrintServer _
	Inherits PrintServer
C#
public sealed class LocalPrintServer : PrintServer
Visual C++
public ref class LocalPrintServer sealed : public PrintServer
F#
[<Sealed>]
type LocalPrintServer =  
    class
        inherit PrintServer
    end

The LocalPrintServer type exposes the following members.

Constructors

  Name Description
Public method LocalPrintServer() Initializes a new instance of the LocalPrintServer class.
Public method LocalPrintServer(LocalPrintServerIndexedProperty[]) Initializes a new instance of the LocalPrintServer class that has the specified LocalPrintServerIndexedProperty array.
Public method LocalPrintServer(PrintSystemDesiredAccess) Initializes a new instance of the LocalPrintServer class that has the specified PrintSystemDesiredAccess.
Public method LocalPrintServer(String[]) Initializes a new instance of the LocalPrintServer class that has the specified properties.
Public method LocalPrintServer(LocalPrintServerIndexedProperty[], PrintSystemDesiredAccess) Initializes a new instance of the LocalPrintServer class that has the specified LocalPrintServerIndexedProperty array and the specified PrintSystemDesiredAccess.
Public method LocalPrintServer(String[], PrintSystemDesiredAccess) Initializes a new instance of the LocalPrintServer class that has the specified properties and PrintSystemDesiredAccess.
Top
Properties

  Name Description
Public property BeepEnabled Gets or sets a value that indicates whether the print server beeps in response to an error condition in the printer. (Inherited from PrintServer.)
Public property DefaultPortThreadPriority Infrastructure. Do not use. (Inherited from PrintServer.)
Public property DefaultPrintQueue Gets or sets the default print queue.
Public property DefaultSchedulerPriority Infrastructure. Do not use. (Inherited from PrintServer.)
Public property DefaultSpoolDirectory Gets or sets the path where the print server's spool files are located. (Inherited from PrintServer.)
Public property EventLog Gets or sets the type of events that the print server logs. (Inherited from PrintServer.)
Protected property IsDelayInitialized Gets or sets a value that indicates whether initialization of the PrintServer properties has been postponed. (Inherited from PrintServer.)
Protected property IsDisposed Gets or sets a value that indicates whether the object has been disposed. (Inherited from PrintSystemObject.)
Public property MajorVersion Gets the major version of the operating system. (Inherited from PrintServer.)
Public property MinorVersion Gets the minor version within the major version of the operating system. (Inherited from PrintServer.)
Public property Name Gets the name of the print server. (Inherited from PrintServer.)
Public property NetPopup Gets or sets a value that indicates whether notifications that a print job has finished are sent to either the print server or the client computer. (Inherited from PrintServer.)
Public property Parent Gets the parent of the object. (Inherited from PrintSystemObject.)
Public property PortThreadPriority Gets or sets the thread priority for the process that manages I/O through the printer ports. (Inherited from PrintServer.)
Public property PropertiesCollection Gets a collection of attribute and value pairs. (Inherited from PrintSystemObject.)
Public property RestartJobOnPoolEnabled Gets or sets a value that indicates whether users can restart jobs after an error occurs if printer pooling is enabled. (Inherited from PrintServer.)
Public property RestartJobOnPoolTimeout Gets or sets a value that indicates the wait time before a job can be restarted, if an error occurs when printer pooling is also enabled. (Inherited from PrintServer.)
Public property SchedulerPriority Gets or sets the thread priority for the process that routes print jobs from applications to print queues. (Inherited from PrintServer.)
Public property SubSystemVersion Gets the version of the print spooler system. (Inherited from PrintServer.)
Top
Methods

  Name Description
Public method Commit Writes any changes that your application made to the properties of the LocalPrintServer to the actual print server that the object represents. (Overrides PrintServer.Commit().)
Public method ConnectToPrintQueue(PrintQueue) Connects the local print server to the specified PrintQueue.
Public method ConnectToPrintQueue(String) Connects to the print queue that is specified by using the String.
Public method DisconnectFromPrintQueue(PrintQueue) Disconnects the local print server from the specified PrintQueue.
Public method DisconnectFromPrintQueue(String) Disconnects from the print queue that is specified in the String.
Public method Dispose() Releases all resources used by the PrintSystemObject. (Inherited from PrintSystemObject.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources. (Inherited from PrintSystemObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases the resources that are being used by the PrintSystemObject. (Inherited from PrintSystemObject.)
Public method Static member GetDefaultPrintQueue Returns a reference to the default print queue of the LocalPrintServer.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPrintQueue(String) Obtains a reference to the named print queue from the print server. (Inherited from PrintServer.)
Public method GetPrintQueue(String, String[]) Gets a specified print queue from the print server. (Inherited from PrintServer.)
Public method GetPrintQueues() Gets the collection of print queues that the print server hosts. (Inherited from PrintServer.)
Public method GetPrintQueues(EnumeratedPrintQueueTypes[]) Gets the collection of print queues of the specified types that are named in EnumeratedPrintQueueTypes and hosted by the print server. (Inherited from PrintServer.)
Public method GetPrintQueues(PrintQueueIndexedProperty[]) Gets a collection of print queues that are hosted by the print server and initialized only in the properties that are specified in the PrintQueueIndexedProperty array. (Inherited from PrintServer.)
Public method GetPrintQueues(String[]) Gets a collection of print queues that are hosted by the print server and that are initialized only in the specified properties. (Inherited from PrintServer.)
Public method GetPrintQueues(PrintQueueIndexedProperty[], EnumeratedPrintQueueTypes[]) Gets a collection of print queues of the specified types. These print queues are only initialized in the properties that are specified in the PrintQueueIndexedProperty array. (Inherited from PrintServer.)
Public method GetPrintQueues(String[], EnumeratedPrintQueueTypes[]) Gets the collection of print queues, which are of the specified EnumeratedPrintQueueTypes and are initialized only in the specified properties. (Inherited from PrintServer.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Initialize Initializes the properties of the PrintSystemObject. (Inherited from PrintSystemObject.)
Public method InstallPrintQueue(String, String, String[], String, PrintPropertyDictionary) Installs a print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)
Public method InstallPrintQueue(String, String, String[], String, PrintQueueAttributes) Installs a print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)
Public method InstallPrintQueue(String, String, String[], String, PrintQueueAttributes, PrintQueueStringProperty, Int32, Int32) Installs a prioritized print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)
Public method InstallPrintQueue(String, String, String[], String, PrintQueueAttributes, String, String, String, String, Int32, Int32) Installs a shared, prioritized print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)
Protected method InternalDispose Releases the unmanaged resources that are used by the PrintServer and optionally releases the managed resources. (Inherited from PrintServer.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Refresh Updates the properties of the LocalPrintServer object so that their values match the values of the print server that the object represents. (Overrides PrintServer.Refresh().)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

When your application writes a value to a property of the LocalPrintServer object, that change has no effect until the value is passed to the computer that is represented by the LocalPrintServer object. To ensure that the change in value takes effect, use the Commit method.

In addition, other applications may also change the print service properties of the computer. To ensure that the LocalPrintServer object used by your application has the latest actual values, use the Refresh method.

Examples

The following example shows how to create an instance of the LocalPrintServer class.

Visual Basic

		' -------------------- GetPrintXpsDocumentWriter() -------------------
		''' <summary>
		'''   Returns an XpsDocumentWriter for the default print queue.</summary>
		''' <returns>
		'''   An XpsDocumentWriter for the default print queue.</returns>
		Private Function GetPrintXpsDocumentWriter() As XpsDocumentWriter
			' Create a local print server
			Dim ps As New LocalPrintServer()

			' Get the default print queue
			Dim pq As PrintQueue = ps.DefaultPrintQueue

			' Get an XpsDocumentWriter for the default print queue
			Dim xpsdw As XpsDocumentWriter = PrintQueue.CreateXpsDocumentWriter(pq)
			Return xpsdw
		End Function ' end:GetPrintXpsDocumentWriter()


C#

// -------------------- GetPrintXpsDocumentWriter() -------------------
/// <summary>
///   Returns an XpsDocumentWriter for the default print queue.</summary>
/// <returns>
///   An XpsDocumentWriter for the default print queue.</returns>
private XpsDocumentWriter GetPrintXpsDocumentWriter()
{
    // Create a local print server
    LocalPrintServer ps = new LocalPrintServer();

    // Get the default print queue
    PrintQueue pq = ps.DefaultPrintQueue;

    // Get an XpsDocumentWriter for the default print queue
    XpsDocumentWriter xpsdw = PrintQueue.CreateXpsDocumentWriter(pq);
    return xpsdw;
}// end:GetPrintXpsDocumentWriter()


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