LocalPrintServer Class
TOC
Collapse the table of content
Expand the table of content

LocalPrintServer Class

 

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

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

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

public sealed class LocalPrintServer : PrintServer

NameDescription
System_CAPS_pubmethodLocalPrintServer()

Initializes a new instance of the LocalPrintServer class.

System_CAPS_pubmethodLocalPrintServer(LocalPrintServerIndexedProperty[])

Initializes a new instance of the LocalPrintServer class that has the specified LocalPrintServerIndexedProperty array.

System_CAPS_pubmethodLocalPrintServer(LocalPrintServerIndexedProperty[], PrintSystemDesiredAccess)

Initializes a new instance of the LocalPrintServer class that has the specified LocalPrintServerIndexedProperty array and the specified PrintSystemDesiredAccess.

System_CAPS_pubmethodLocalPrintServer(PrintSystemDesiredAccess)

Initializes a new instance of the LocalPrintServer class that has the specified PrintSystemDesiredAccess.

System_CAPS_pubmethodLocalPrintServer(String[])

Initializes a new instance of the LocalPrintServer class that has the specified properties.

System_CAPS_pubmethodLocalPrintServer(String[], PrintSystemDesiredAccess)

Initializes a new instance of the LocalPrintServer class that has the specified properties and PrintSystemDesiredAccess.

NameDescription
System_CAPS_pubpropertyBeepEnabled

Gets or sets a value that indicates whether the print server beeps in response to an error condition in the printer. (Inherited from PrintServer.)

System_CAPS_pubpropertyDefaultPortThreadPriority

This API supports the product infrastructure and is not intended to be used directly from your code. Do not use.(Inherited from PrintServer.)

System_CAPS_pubpropertyDefaultPrintQueue

Gets or sets the default print queue.

System_CAPS_pubpropertyDefaultSchedulerPriority

This API supports the product infrastructure and is not intended to be used directly from your code. Do not use.(Inherited from PrintServer.)

System_CAPS_pubpropertyDefaultSpoolDirectory

Gets or sets the path where the print server's spool files are located. (Inherited from PrintServer.)

System_CAPS_pubpropertyEventLog

Gets or sets the type of events that the print server logs. (Inherited from PrintServer.)

System_CAPS_pubpropertyMajorVersion

Gets the major version of the operating system. (Inherited from PrintServer.)

System_CAPS_pubpropertyMinorVersion

Gets the minor version within the major version of the operating system. (Inherited from PrintServer.)

System_CAPS_pubpropertyName

Gets the name of the print server. (Inherited from PrintServer.)

System_CAPS_pubpropertyNetPopup

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.)

System_CAPS_pubpropertyParent

Gets the parent of the object. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyPortThreadPriority

Gets or sets the thread priority for the process that manages I/O through the printer ports. (Inherited from PrintServer.)

System_CAPS_pubpropertyPropertiesCollection

Gets a collection of attribute and value pairs. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyRestartJobOnPoolEnabled

Gets or sets a value that indicates whether users can restart jobs after an error occurs if printer pooling is enabled.(Inherited from PrintServer.)

System_CAPS_pubpropertyRestartJobOnPoolTimeout

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.)

System_CAPS_pubpropertySchedulerPriority

Gets or sets the thread priority for the process that routes print jobs from applications to print queues. (Inherited from PrintServer.)

System_CAPS_pubpropertySubSystemVersion

Gets the version of the print spooler system. (Inherited from PrintServer.)

NameDescription
System_CAPS_pubmethodCommit()

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().)

System_CAPS_pubmethodConnectToPrintQueue(PrintQueue)

Connects the local print server to the specified PrintQueue.

System_CAPS_pubmethodConnectToPrintQueue(String)

Connects to the print queue that is specified by using the String.

System_CAPS_pubmethodDisconnectFromPrintQueue(PrintQueue)

Disconnects the local print server from the specified PrintQueue.

System_CAPS_pubmethodDisconnectFromPrintQueue(String)

Disconnects from the print queue that is specified in the String.

System_CAPS_pubmethodDispose()

Releases all resources used by the PrintSystemObject. (Inherited from PrintSystemObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetDefaultPrintQueue()

Returns a reference to the default print queue of the LocalPrintServer.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetPrintQueue(String)

Obtains a reference to the named print queue from the print server. (Inherited from PrintServer.)

System_CAPS_pubmethodGetPrintQueue(String, String[])

Gets a specified print queue from the print server. (Inherited from PrintServer.)

System_CAPS_pubmethodGetPrintQueues()

Gets the collection of print queues that the print server hosts. (Inherited from PrintServer.)

System_CAPS_pubmethodGetPrintQueues(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.)

System_CAPS_pubmethodGetPrintQueues(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.)

System_CAPS_pubmethodGetPrintQueues(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.)

System_CAPS_pubmethodGetPrintQueues(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.)

System_CAPS_pubmethodGetPrintQueues(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.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInstallPrintQueue(String, String, String[], String, PrintPropertyDictionary)

Installs a print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)

System_CAPS_pubmethodInstallPrintQueue(String, String, String[], String, PrintQueueAttributes)

Installs a print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)

System_CAPS_pubmethodInstallPrintQueue(String, String, String[], String, PrintQueueAttributes, PrintQueueStringProperty, Int32, Int32)

Installs a prioritized print queue, and associated printer driver, on the print server. (Inherited from PrintServer.)

System_CAPS_pubmethodInstallPrintQueue(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.)

System_CAPS_pubmethodRefresh()

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().)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

System_CAPS_cautionCaution

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.

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

// -------------------- 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()

.NET Framework
Available since 3.0

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

Return to top
Show:
© 2016 Microsoft