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

PrintServer Class

 

Manages the print queues on a print server, which is usually a computer, but can be a dedicated hardware print server appliance.

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


public class PrintServer : PrintSystemObject

NameDescription
System_CAPS_pubmethodPrintServer()

Initializes a new instance of the PrintServer class.

System_CAPS_pubmethodPrintServer(PrintSystemDesiredAccess)

Initializes a new instance of the PrintServer class that represents the local print server and assigns it the specified PrintSystemDesiredAccess.

System_CAPS_pubmethodPrintServer(String)

Initializes a new instance of the PrintServer class that has the specified path.

System_CAPS_pubmethodPrintServer(String, PrintServerIndexedProperty[])

Initializes a new instance of the PrintServer class by using the specified PrintServerIndexedProperty array to determine which properties will be initialized.

System_CAPS_pubmethodPrintServer(String, PrintServerIndexedProperty[], PrintSystemDesiredAccess)

Initializes a new instance of the PrintServer class and provides the specified path, the PrintServerIndexedProperty array, and the needed access.

System_CAPS_pubmethodPrintServer(String, PrintSystemDesiredAccess)

Initializes a new instance of the PrintServer class that has the specified path and the needed access.

System_CAPS_pubmethodPrintServer(String, String[])

Initializes a new instance of the PrintServer class that has the specified path and properties filter.

System_CAPS_pubmethodPrintServer(String, String[], PrintSystemDesiredAccess)

Initializes a new instance of the PrintServer class that has the specified path, properties filter, and the needed access.

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.

System_CAPS_pubpropertyDefaultPortThreadPriority

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

System_CAPS_pubpropertyDefaultSchedulerPriority

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

System_CAPS_pubpropertyDefaultSpoolDirectory

Gets or sets the path where the print server's spool files are located.

System_CAPS_pubpropertyEventLog

Gets or sets the type of events that the print server logs.

System_CAPS_protpropertyIsDelayInitialized

Gets or sets a value that indicates whether initialization of the PrintServer properties has been postponed.

System_CAPS_protpropertyIsDisposed

Gets or sets a value that indicates whether the object has been disposed. (Inherited from PrintSystemObject.)

System_CAPS_pubpropertyMajorVersion

Gets the major version of the operating system.

System_CAPS_pubpropertyMinorVersion

Gets the minor version within the major version of the operating system.

System_CAPS_pubpropertyName

Gets the name of the print server. (Overrides PrintSystemObject.Name.)

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.

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.

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.

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.

System_CAPS_pubpropertySchedulerPriority

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

System_CAPS_pubpropertySubSystemVersion

Gets the version of the print spooler system.

NameDescription
System_CAPS_pubmethodCommit()

Commits any changes that your program made to the properties of the print server object by writing them to the print server that the object represents. (Overrides PrintSystemObject.Commit().)

System_CAPS_pubmethodSystem_CAPS_staticDeletePrintQueue(PrintQueue)

Removes the specified PrintQueue from the print server.

System_CAPS_pubmethodSystem_CAPS_staticDeletePrintQueue(String)

Removes the print queue with the specified name from the print server.

System_CAPS_pubmethodDispose()

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

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the PrintSystemObject and optionally releases the managed resources. (Inherited from PrintSystemObject.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Releases the resources that are being used by the PrintSystemObject. (Inherited from PrintSystemObject.)

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.

System_CAPS_pubmethodGetPrintQueue(String, String[])

Gets a specified print queue from the print server.

System_CAPS_pubmethodGetPrintQueues()

Gets the collection of print queues that the print server hosts.

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.

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.

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.

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.

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.

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodInitialize()

Initializes the properties of the PrintSystemObject. (Inherited from PrintSystemObject.)

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

Installs a print queue, and associated printer driver, on the print server.

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

Installs a print queue, and associated printer driver, on the print server.

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

Installs a prioritized print queue, and associated printer driver, on the print server.

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.

System_CAPS_protmethodInternalDispose(Boolean)

Releases the unmanaged resources that are used by the PrintServer and optionally releases the managed resources. (Overrides PrintSystemObject.InternalDispose(Boolean).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRefresh()

Updates the properties of the PrintServer object so that each property value matches the corresponding attribute value of the print server that the object represents. (Overrides PrintSystemObject.Refresh().)

System_CAPS_pubmethodToString()

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

When your program writes a value to a property of PrintServer, that change has no effect until it is passed on to the computer that is represented by the PrintServer object. To commit changes, use the Commit method for the object.

Similarly, other applications may change the actual print service properties of the computer. To make sure that the PrintServer object for your program has the latest values, use the Refresh method for the object.

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


// Create a PrintServer
// "theServer" must be a print server to which the user has full print access.
PrintServer myPrintServer = new PrintServer(@"\\theServer");

// List the print server's queues
PrintQueueCollection myPrintQueues = myPrintServer.GetPrintQueues();
String printQueueNames = "My Print Queues:\n\n";
foreach (PrintQueue pq in myPrintQueues)
{
    printQueueNames += "\t" + pq.Name + "\n";
}
Console.WriteLine(printQueueNames);
Console.WriteLine("\nPress Return to continue.");
Console.ReadLine();

.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