wmi Win32_Printer reference for Network Programming in .NET with C# & Visual Basic .NET (VB.NET)

WMI class ' Win32_Printer ' reference for C# and VB.NET

MOF Reference

[Description("The Win32_Printer class represents a device connected to a Win32 computer system that is capable of reproducing a visual image on a medium."): ToSubClass, AMENDMENT, LOCALE(1033)]
class Win32_Printer : CIM_Printer
{
	[Description("The DeviceID property contains a string uniquely identifying the printer  with other devices on the system."): ToSubClass, key] string DeviceID = NULL;
	[Description("The Attributes property indicates the attributes of the Win32 printing device. These attributes are represented through a combination of flags. Attributes of the printer include:\nQueued  - Print jobs are buffered and queued.\n Direct  - Specifies that the document should be sent directly to the printer.  This is used if print job are not being properly queued.\nDefault - The printer is the default printer on the computer.\nShared - Available as a shared network resource.\nNetwork - Attached to the network.\nHidden - Hidden from some users on the network.\nLocal - Directly connected to this computer.\nEnableDevQ - Enable the queue on the printer if available.\nKeepPrintedJobs - Specifies that the spooler should not delete documents after they are printed.\nDoCompleteFirst - Start jobs that are finished spooling first.\nWorkOffline - Queue print jobs when printer is not available.\nEnableBIDI - Enable bi-directional printing.\nRawOnly - Allow only raw data type jobs to be spooled.\nPublished - Indicates whether the printer is published in the network directory service.\n"): ToSubClass, BitValues{"Queued", "Direct", "Default", "Shared", "Network", "Hidden", "Local", "EnableDevQ", "KeepPrintedJobs", "DoCompleteFirst", "WorkOffline", "EnableBIDI", "RawOnly", "Published"}: ToSubClass] uint32 Attributes;
	[Description("The Queued property indicates whether the printer buffers and queues print jobs."): ToSubClass] boolean Queued;
	[Description("The Direct property indicates whether the print jobs should be sent directly to the printer.  This means that no spool files are created for the print jobs.\n"): ToSubClass] boolean Direct;
	[Description("The Default property indicates whether the printer is the default printer on the computer."): ToSubClass] boolean Default;
	[Description("The Shared property indicates whether the printer is available as a shared network resource."): ToSubClass] boolean Shared;
	[Description("The Network property indicates whether the printer is a network printer."): ToSubClass] boolean Network;
	[Description("The Local property indicates whether the printer is attached to the network.  A masquerading printer is printer that is implemented as local printers but has a port that refers to a remote machine.  From the application perspective these hybrid printers should be viewed as printer connections since that is their intended behavior."): ToSubClass] boolean Local;
	[Description("The Hidden property indicates whether the printer is hidden from network users."): ToSubClass] boolean Hidden;
	[Description("The EnableDevQueryPrint property indicates whether to hold documents in the queue, if document and printer setups do not match"): ToSubClass] boolean EnableDevQueryPrint;
	[Description("The KeepPrintedJobs property indicates whether the print spooler should not delete the jobs after they are completed."): ToSubClass] boolean KeepPrintedJobs;
	[Description("The DoCompleteFirst property indicates whether the printer should start jobs that have finished spooling as opposed to the order of the job received."): ToSubClass] boolean DoCompleteFirst;
	[Description("The WorkOffline property indicates whether to queue print jobs on the computer if the printer is offline."): ToSubClass] boolean WorkOffline;
	[Description("The EnableBIDI property indicates whether the printer can print bidirectionally."): ToSubClass] boolean EnableBIDI;
	[Description("The RawOnly property indicates whether the printer accepts only raw data to be spooled."): ToSubClass] boolean RawOnly;
	[Description("The Published property indicates whether the printer is published in the network directory service."): ToSubClass] boolean Published;
	[Description("The DriverName property specifies the name of the Win32 printer driver.\nExample: Windows NT Fax Driver"): ToSubClass] string DriverName;
	[Description("The Comment property specifies the comment of a print queue.\nExample: Color printer"): ToSubClass] string Comment;
	[Description("The Location property specifies the physical location of the printer.\nExample: Bldg. 38, Room 1164"): ToSubClass] string Location;
	[Description("The Parameters property specifies optional parameters for the print processor.\nExample: Copies=2"): ToSubClass] string Parameters;
	[Description("The PrinterPaperNames property indicates the list of paper sizes supported by the printer. The printer-specified names are used to represent supported paper sizes.\nExample: B5 (JIS)."): ToSubClass] string PrinterPaperNames[];
	[Description("The PortName property identifies the ports that can be used to transmit data to the printer. If a printer is connected to more than one port, the names of each port are separated by commas. Under Windows 95, only one port can be specified. \nExample: LPT1:, LPT2:, LPT3:"): ToSubClass] string PortName;
	[Description("The PrintJobDataType property indicates the default data type that will be used for a print job."): ToSubClass] string PrintJobDataType;
	[Description("This property has been deprecated in favor of PrinterStatus, DetectedErrorState and ErrorInformation CIM properties that more clearly indicate the state and error status of the printer. The PrinterState property specifies a values indicating one of the possible states relating to this printer."): ToSubClass, Values{"Paused", "Error", "Pending Deletion", "Paper Jam", "Paper Out", "Manual Feed", "Paper Problem", "Offline", "IO Active", "Busy", "Printing", "Output Bin Full", "Not Available", "Waiting", "Processing", "Initialization", "Warming Up", "Toner Low", "No Toner", "Page Punt", "User Intervention Required", "Out of Memory", "Door Open", "Server_Unknown", "Power Save"}: ToSubClass] uint32 PrinterState;
	[Description("Status information for a Printer, beyond that specified in the LogicalDevice Availability property. Values include \"Idle\" (3) and an indication that the Device is currently printing (4)."): ToSubClass, Values{"Other", "Unknown", "Idle", "Printing", "Warmup", "Stopped Printing", "Offline", "Paused", "Error", "Busy", "Not Available", "Waiting", "Processing", "Initialization", "Power Save", "Pending Deletion", "I/O Active", "Manual Feed"}: ToSubClass] uint16 ExtendedPrinterStatus;
	[Description("The ExtendedDetectedErrorState property reports standard error information.  Any additional information should be recorded in the DetecteErrorState property."): ToSubClass, Values{"Unknown", "Other", "No Error", "Low Paper", "No Paper", "Low Toner", "No Toner", "Door Open", "Jammed", "Service Requested", "Output Bin Full", "Paper Problem", "Cannot Print Page", "User Intervention Required", "Out of Memory", "Server Unknown"}: ToSubClass] uint16 ExtendedDetectedErrorState;
	[Description("The SeparatorFile property specifies the name of the file used to create a separator page. This page is used to separate print jobs sent to the printer."): ToSubClass] string SeparatorFile;
	[Description("The ServerName property identifies the server that controls the printer. If this string is NULL, the printer is controlled locally. "): ToSubClass] string ServerName;
	[Description("The ShareName property indicates the share name of the Win32 printing device.\nExample: \\\\PRINTSERVER1\\PRINTER2"): ToSubClass] string ShareName;
	[Description("The StartTime property specifies the earliest time the printer can print a job (if the printer has been limited to print only at certain times). This value is expressed as time elapsed since 12:00 AM GMT (Greenwich mean time)."): ToSubClass] datetime StartTime;
	[Description("The UntilTime property specifies the latest time the printer can print a job (if the printer has been limited to print only at certain times). This value is expressed as time elapsed since 12:00 AM GMT (Greenwich mean time)."): ToSubClass] datetime UntilTime;
	[Description("The DefaultPriority property specifies the default priority value assigned to each print job."): ToSubClass] uint32 DefaultPriority;
	[Description("The Priority property specifies the priority of the  printer. The jobs on a higher priority printer are scheduled first."): ToSubClass] uint32 Priority;
	[Description("The AveragePagesPerMinute property specifies the rate (average number of pages per minute) that the printer is capable of sustaining."): ToSubClass] uint32 AveragePagesPerMinute;
	[Description("The PrintProcessor property specifies the name of the print spooler that handles print jobs.\nExample: SPOOLSS.DLL."): ToSubClass] string PrintProcessor;
	[Description("The SpoolEnabled property shows whether spooling is enabled for this printer. \nValues:TRUE or FALSE. \nThe SpoolEnabled property has been deprecated.  There is no replacementvalue and this property is now considered obsolete."): ToSubClass] boolean SpoolEnabled;
	[Description("The Pause method pauses the print queue. No jobs can print anymore until the print queue is resumed. The method can return the following values:\n0 - Success.\n5 - Access denied.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Other"}: ToSubClass] uint32 Pause();
	[Description("The Resume method resumes a paused print queue. The method can return the following values:\n0 - Success.\n5 - Access denied.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Other"}: ToSubClass] uint32 Resume();
	[Description("The CancelAllJobs method cancels and removes all print jobs from the printer queue including the job currently printing. The method can return the following values:\n0 - Success.\n5 - Access denied.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Other"}: ToSubClass] uint32 CancelAllJobs();
	[Description("The AddPrinterConnection method provides a connection to an existing printer on the network and adds it to the list of available printers on the computer system. If successful, applications will be able to use this printer for print jobs.  If unsuccessful the printer is not installed. The method can return the following values:\n0 - Success.\n5 - Access denied.\n1801 - Invalid printer name.\n1930 - Incompatible printer driver.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Invalid printer name", "The printer driver is not compatible with a policy enabled on your computer that blocks NT 4.0 drivers", "Other"}: ToSubClass] uint32 AddPrinterConnection([In, Description("The Name parameter specifies a friendly name for the printer.  This may be overridden if the name has alreadybeen set by the printer."): ToSubClass] string Name);
	[Description("The RenamePrinter method renames a printer. The method can return the following values:\n0 - Success.\n5 - Access denied.\n1801 - Invalid printer name.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Invalid printer name", "Other"}: ToSubClass] uint32 RenamePrinter([In, Description("The NewPrinterName parameter specifies the new printer name."): ToSubClass] string NewPrinterName);
	[Description("The PrintTestPage method prints a test page. The method can return the following values:\n0 - Success.\n5 - Access denied.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Access denied", "Other"}: ToSubClass] uint32 PrintTestPage();
	[Description("The SetDefaultPrinter method sets the printer to be the default printer for the user who executes the method. The method can return the following values:\n0 - Success.\nOther - For integer values other than those listed above, refer to the documentation on the Win32 error codes."): ToSubClass, Values{"Success", "Other"}: ToSubClass] uint32 SetDefaultPrinter();
};

Class properties:

Win32_Printer.Attributes
Win32_Printer.Availability
Win32_Printer.AvailableJobSheets
Win32_Printer.AveragePagesPerMinute
Win32_Printer.Capabilities
Win32_Printer.CapabilityDescriptions
Win32_Printer.Caption
Win32_Printer.CharSetsSupported
Win32_Printer.Comment
Win32_Printer.ConfigManagerErrorCode
Win32_Printer.ConfigManagerUserConfig
Win32_Printer.CreationClassName
Win32_Printer.CurrentCapabilities
Win32_Printer.CurrentCharSet
Win32_Printer.CurrentLanguage
Win32_Printer.CurrentMimeType
Win32_Printer.CurrentNaturalLanguage
Win32_Printer.CurrentPaperType
Win32_Printer.Default
Win32_Printer.DefaultCapabilities
Win32_Printer.DefaultCopies
Win32_Printer.DefaultLanguage
Win32_Printer.DefaultMimeType
Win32_Printer.DefaultNumberUp
Win32_Printer.DefaultPaperType
Win32_Printer.DefaultPriority
Win32_Printer.Description
Win32_Printer.DetectedErrorState
Win32_Printer.DeviceID
Win32_Printer.Direct
Win32_Printer.DoCompleteFirst
Win32_Printer.DriverName
Win32_Printer.EnableBIDI
Win32_Printer.EnableDevQueryPrint
Win32_Printer.ErrorCleared
Win32_Printer.ErrorDescription
Win32_Printer.ErrorInformation
Win32_Printer.ExtendedDetectedErrorState
Win32_Printer.ExtendedPrinterStatus
Win32_Printer.Hidden
Win32_Printer.HorizontalResolution
Win32_Printer.InstallDate
Win32_Printer.JobCountSinceLastReset
Win32_Printer.KeepPrintedJobs
Win32_Printer.LanguagesSupported
Win32_Printer.LastErrorCode
Win32_Printer.Local
Win32_Printer.Location
Win32_Printer.MarkingTechnology
Win32_Printer.MaxCopies
Win32_Printer.MaxNumberUp
Win32_Printer.MaxSizeSupported
Win32_Printer.MimeTypesSupported
Win32_Printer.Name
Win32_Printer.NaturalLanguagesSupported
Win32_Printer.Network
Win32_Printer.PaperSizesSupported
Win32_Printer.PaperTypesAvailable
Win32_Printer.Parameters
Win32_Printer.PNPDeviceID
Win32_Printer.PortName
Win32_Printer.PowerManagementCapabilities
Win32_Printer.PowerManagementSupported
Win32_Printer.PrinterPaperNames
Win32_Printer.PrinterState
Win32_Printer.PrinterStatus
Win32_Printer.PrintJobDataType
Win32_Printer.PrintProcessor
Win32_Printer.Priority
Win32_Printer.Published
Win32_Printer.Queued
Win32_Printer.RawOnly
Win32_Printer.SeparatorFile
Win32_Printer.ServerName
Win32_Printer.Shared
Win32_Printer.ShareName
Win32_Printer.SpoolEnabled
Win32_Printer.StartTime
Win32_Printer.Status
Win32_Printer.StatusInfo
Win32_Printer.SystemCreationClassName
Win32_Printer.SystemName
Win32_Printer.TimeOfLastReset
Win32_Printer.UntilTime
Win32_Printer.VerticalResolution
Win32_Printer.WorkOffline

WMI is a huge subject, so therefore it is practically impossible to provide a comprehensive example program that covers anything. However, the book �Network programming in .NET� (Buy at Amazon UK) (Buy at Amazon US) covers a much wider scope of WMI, and explains how to leverage it to access the bounty of information held within this vast, yet simple object model.

Articles

Contact us

Please use FireFox to view this page

WMI class ' Win32_Printer ' reference for C# and VB.NET

MOF Reference

Class properties: