BACK TO INDEX

Win32_Printer
The Win32_Printer class represents a device connected to a Win32 computer system that is capable of reproducing a visual image on a medium.
NameSpace Path
\ROOT\CIMV2
PROPERTYSMS_REPORTCIMTYPEDESCRIPTION
AttributesUInt32The Attributes property indicates the attributes of the Win32 printing device. These attributes are represented through a combination of flags. Attributes of the printer include: Queued - Print jobs are buffered and queued. Direct - Specifies that the document should be sent directly to the printer. This is used if print job are not being properly queued. Default - The printer is the default printer on the computer. Shared - Available as a shared network resource. Network - Attached to the network. Hidden - Hidden from some users on the network. Local - Directly connected to this computer. EnableDevQ - Enable the queue on the printer if available. KeepPrintedJobs - Specifies that the spooler should not delete documents after they are printed. DoCompleteFirst - Start jobs that are finished spooling first. WorkOffline - Queue print jobs when printer is not available. EnableBIDI - Enable bi-directional printing. RawOnly - Allow only raw data type jobs to be spooled. Published - Indicates whether the printer is published in the network directory service.
AvailabilityUInt16The availability and status of the device. For example, the Availability property indicates that the device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the power saving states, these are defined as follows: Value 13 ("Power Save - Unknown") indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low Power Mode") indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") describes that the device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the device is in a warning state, though also in a power save mode.
AvailableJobSheetsStringDescribes all of the job sheets that are available on the Printer. This can also be used to describe the banner that a Printer might provide at the beginning of each Job, or can describe other user specified options.
AveragePagesPerMinuteUInt32The AveragePagesPerMinute property specifies the rate (average number of pages per minute) that the printer is capable of sustaining.
CapabilitiesUInt16An array of integers indicating Printer capabilities. Information such as "Duplex Printing" (value=3) or "Transparency Printing" (7) is specified in this property.
CapabilityDescriptionsStringAn array of free-form strings providing more detailed explanations for any of the Printer features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
CaptionStringThe Caption property is a short textual description (one-line string) of the object.
CharSetsSupportedStringIdentifies the available character sets for the output of text related to managing the Printer. Strings provided in this property should conform to the semantics and syntax specified by section 4.1.2 ("Charset parameter") in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include "utf-8", "us-ascii" and "iso-8859-1".
CommentStringThe Comment property specifies the comment of a print queue. Example: Color printer
ConfigManagerErrorCodeUInt32Indicates the Win32 Configuration Manager error code. The following values may be returned: 0 This device is working properly. 1 This device is not configured correctly. 2 Windows cannot load the driver for this device. 3 The driver for this device might be corrupted, or your system may be running low on memory or other resources. 4 This device is not working properly. One of its drivers or your registry might be corrupted. 5 The driver for this device needs a resource that Windows cannot manage. 6 The boot configuration for this device conflicts with other devices. 7 Cannot filter. 8 The driver loader for the device is missing. 9 This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly. 10 This device cannot start. 11 This device failed. 12 This device cannot find enough free resources that it can use. 13 Windows cannot verify this device's resources. 14 This device cannot work properly until you restart your computer. 15 This device is not working properly because there is probably a re-enumeration problem. 16 Windows cannot identify all the resources this device uses. 17 This device is asking for an unknown resource type. 18 Reinstall the drivers for this device. 19 Your registry might be corrupted. 20 Failure using the VxD loader. 21 System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device. 22 This device is disabled. 23 System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation. 24 This device is not present, is not working properly, or does not have all its drivers installed. 25 Windows is still setting up this device. 26 Windows is still setting up this device. 27 This device does not have valid log configuration. 28 The drivers for this device are not installed. 29 This device is disabled because the firmware of the device did not give it the required resources. 30 This device is using an Interrupt Request (IRQ) resource that another device is using. 31 This device is not working properly because Windows cannot load the drivers required for this device.
ConfigManagerUserConfigBooleanIndicates whether the device is using a user-defined configuration.
CreationClassNameStringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
CurrentCapabilitiesUInt16Specifies which finishings and other capabilities of the Printer are currently being used. An entry in this property should also be listed in the Capabilities array.
CurrentCharSetStringSpecifies the current character set being used for the output of text relating to management of the Printer. The character set described by this property should also be listed in CharsetsSupported. The string specified by this property should conform to the semantics and syntax specified by section 4.1.2 ("Charset parameter") in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include "utf-8", "us-ascii" and "iso-8859-1".
CurrentLanguageUInt16Indicates the current printer language being used. A language that is being used by the Printer should also be listed in LanguagesSupported.
CurrentMimeTypeStringSpecifies the mime type currently being used by the Printer if the CurrentLanguage is set to indicate a mime type is in use (value = 47).
CurrentNaturalLanguageStringIdentifies the current language being used by the Printer for management. The language listed in the CurrentNaturalLanguage property should also be listed in NaturalLanguagesSupported.
CurrentPaperTypeStringSpecifies the paper type that the Printer is currently using. The string should be expressed in the form specified by ISO/IEC 10175 Document Printing Application (DPA) which is also summarized in Appendix C of RFC 1759 (Printer MIB).
DefaultBooleanThe Default property indicates whether the printer is the default printer on the computer.
DefaultCapabilitiesUInt16Specifies which finishings and other capabilities of the Printer will be used by default. An entry in DefaultCapabilities should also be listed in the Capabilities array.
DefaultCopiesUInt32The number of copies that will be produced for a single Job unless otherwise specified.
DefaultLanguageUInt16Indicates the default printer language. A language that is used as a default by the Printer should also be listed in LanguagesSupported.
DefaultMimeTypeStringSpecifies the default mime type used by the Printer if the DefaultLanguage is set to indicate a mime type is in use (value=47).
DefaultNumberUpUInt32The number of print-stream pages that the Printer will render onto a single media sheet unless a Job specifies otherwise.
DefaultPaperTypeStringSpecifies the paper type that the Printer will use if a PrintJob does not specify a particular type. The string should be expressed in the form specified by ISO/IEC 10175 Document Printing Application (DPA) which is also summarized in Appendix C of RFC 1759 (Printer MIB).
DefaultPriorityUInt32The DefaultPriority property specifies the default priority value assigned to each print job.
DescriptionStringThe Description property provides a textual description of the object.
DetectedErrorStateUInt16Printer error information.
DeviceIDStringThe DeviceID property contains a string uniquely identifying the printer with other devices on the system.
DirectBooleanThe 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.
DoCompleteFirstBooleanThe DoCompleteFirst property indicates whether the printer should start jobs that have finished spooling as opposed to the order of the job received.
DriverNameStringThe DriverName property specifies the name of the Win32 printer driver. Example: Windows NT Fax Driver
EnableBIDIBooleanThe EnableBIDI property indicates whether the printer can print bidirectionally.
EnableDevQueryPrintBooleanThe EnableDevQueryPrint property indicates whether to hold documents in the queue, if document and printer setups do not match
ErrorClearedBooleanErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.
ErrorDescriptionStringErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.
ErrorInformationStringAn array providing supplemental information for the current error state, indicated in DetectedErrorState.
ExtendedDetectedErrorStateUInt16The ExtendedDetectedErrorState property reports standard error information. Any additional information should be recorded in the DetecteErrorState property.
ExtendedPrinterStatusUInt16Status 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).
HiddenBooleanThe Hidden property indicates whether the printer is hidden from network users.
HorizontalResolutionUInt32Printer's horizontal resolution in Pixels per Inch.
InstallDateDateTimeThe InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.
JobCountSinceLastResetUInt32Printer jobs processed since last reset. These jobs may be processed from one or more PrintQueues.
KeepPrintedJobsBooleanThe KeepPrintedJobs property indicates whether the print spooler should not delete the jobs after they are completed.
LanguagesSupportedUInt16An array indicating the print languages natively supported.
LastErrorCodeUInt32LastErrorCode captures the last error code reported by the logical device.
LocalBooleanThe 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.
LocationStringThe Location property specifies the physical location of the printer. Example: Bldg. 38, Room 1164
MarkingTechnologyUInt16Specifies the marking technology used by the Printer.
MaxCopiesUInt32The maximum number of copies that can be produced by the Printer from a single Job.
MaxNumberUpUInt32The maximum number of print-stream pages that the Printer can render onto a single media sheet.
MaxSizeSupportedUInt32Specifies the largest Job (as a byte stream) that the Printer will accept in units of Kbytes. A value of zero indicates that no limit has been set.
MimeTypesSupportedStringAn array of free-form strings providing more detailed explanations of any mime types that are supported by the Printer. If data is provided for this property, then the value 47, "Mime", should be included in the LanguagesSupported property.
NameStringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.
NaturalLanguagesSupportedStringIdentifies the available languages for strings used by the Printer for the output of management information. The strings should conform to RFC 1766, for example "en" is used for English.
NetworkBooleanThe Network property indicates whether the printer is a network printer.
PaperSizesSupportedUInt16An integer array indicating the types of paper supported.
PaperTypesAvailableStringAn array of free-form strings specifying the types of paper that are currently available on the Printer. Each string should be expressed in the form specified by ISO/IEC 10175 Document Printing Application (DPA) which is also summarized in Appendix C of RFC 1759 (Printer MIB). Examples of valid strings are "iso-a4-colored" and "na-10x14-envelope". By definition a paper size that is available and listed in PaperTypesAvailable should also appear in the PaperSizesSupported property.
ParametersStringThe Parameters property specifies optional parameters for the print processor. Example: Copies=2
PNPDeviceIDStringIndicates the Win32 Plug and Play device ID of the logical device. Example: *PNP030b
PortNameStringThe 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. Example: LPT1:, LPT2:, LPT3:
PowerManagementCapabilitiesUInt16Indicates the specific power-related capabilities of the logical device. The array values, 0="Unknown", 1="Not Supported" and 2="Disabled" are self-explanatory. The value, 3="Enabled" indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. "Power Saving Modes Entered Automatically" (4) describes that a device can change its power state based on usage or other criteria. "Power State Settable" (5) indicates that the SetPowerState method is supported. "Power Cycling Supported" (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle"). "Timed Power On Supported" (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.
PowerManagementSupportedBooleanBoolean indicating that the Device can be power managed - ie, put into a power save state. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. Refer to the PowerManagementCapabilities array for this information. If this boolean is false, the integer value 1, for the string, "Not Supported", should be the only entry in the PowerManagementCapabilities array.
PrinterPaperNamesStringThe PrinterPaperNames property indicates the list of paper sizes supported by the printer. The printer-specified names are used to represent supported paper sizes. Example: B5 (JIS).
PrinterStateUInt32This 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.
PrinterStatusUInt16Status 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).
PrintJobDataTypeStringThe PrintJobDataType property indicates the default data type that will be used for a print job.
PrintProcessorStringThe PrintProcessor property specifies the name of the print spooler that handles print jobs. Example: SPOOLSS.DLL.
PriorityUInt32The Priority property specifies the priority of the printer. The jobs on a higher priority printer are scheduled first.
PublishedBooleanThe Published property indicates whether the printer is published in the network directory service.
QueuedBooleanThe Queued property indicates whether the printer buffers and queues print jobs.
RawOnlyBooleanThe RawOnly property indicates whether the printer accepts only raw data to be spooled.
SeparatorFileStringThe 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.
ServerNameStringThe ServerName property identifies the server that controls the printer. If this string is NULL, the printer is controlled locally.
SharedBooleanThe Shared property indicates whether the printer is available as a shared network resource.
ShareNameStringThe ShareName property indicates the share name of the Win32 printing device. Example: \\PRINTSERVER1\PRINTER2
SpoolEnabledBooleanThe SpoolEnabled property shows whether spooling is enabled for this printer. Values:TRUE or FALSE. The SpoolEnabled property has been deprecated. There is no replacementvalue and this property is now considered obsolete.
StartTimeDateTimeThe 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).
StatusStringThe Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.
StatusInfoUInt16StatusInfo is a string indicating whether the logical device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the logical device, the value, 5 ("Not Applicable"), should be used.
SystemCreationClassNameStringThe scoping System's CreationClassName.
SystemNameStringThe scoping System's Name.
TimeOfLastResetDateTimeTime of last reset of the Printer Device.
UntilTimeDateTimeThe 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).
VerticalResolutionUInt32Printer's vertical resolution in Pixels per Inch.
WorkOfflineBooleanThe WorkOffline property indicates whether to queue print jobs on the computer if the printer is offline.
SAMPLE DATA INSTANCE
   [LOCALE(1033): ToInstance Amended]
   instance of Win32_Printer
   {
    Attributes = 33344;
    AveragePagesPerMinute = 0;
    Capabilities = {4, 2, 3, 5};
    CapabilityDescriptions = {"Copies", "Color", "Duplex", "Collate"};
    Caption = "Microsoft XPS Document Writer (from DW2003L1) in session 1";
    CreationClassName = "Win32_Printer";
    Default = FALSE;
    DefaultPriority = 0;
    DetectedErrorState = 0;
    DeviceID = "Microsoft XPS Document Writer (from DW2003L1) in session 1";
    Direct = FALSE;
    DoCompleteFirst = TRUE;
    DriverName = "Microsoft XPS Document Writer";
    EnableBIDI = FALSE;
    EnableDevQueryPrint = FALSE;
    ExtendedDetectedErrorState = 0;
    ExtendedPrinterStatus = 2;
    Hidden = FALSE;
    HorizontalResolution = 600;
    JobCountSinceLastReset = 0;
    KeepPrintedJobs = FALSE;
    Local = TRUE;
    Name = "Microsoft XPS Document Writer (from DW2003L1) in session 1";
    Network = FALSE;
    PaperSizesSupported = {7, 7, 1, 1, 8, 1, 1, 21, 22, 1, 23, 54, 55, 1, 1, 1, 1, 7, 15, 11, 1, 1, 1, 4, 5, 6, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 49, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1};
    PortName = "TS004";
    PrinterPaperNames = {"Letter", "Letter Small", "Tabloid", "Ledger", "Legal", "Statement", "Executive", "A3", "A4", "A4 Small", "A5", "B4 (JIS)", "B5 (JIS)", "Folio", "Quarto", "10x14", "11x17", "Note", "Envelope #9", "Envelope #10", "Envelope #11", "Envelope #12", "Envelope #14", "C size sheet", "D size sheet", "E size sheet", "Envelope DL", "Envelope C5", "Envelope C3", "Envelope C4", "Envelope C6", "Envelope C65", "Envelope B4", "Envelope B5", "Envelope B6", "Envelope", "Envelope Monarch", "6 3/4 Envelope", "US Std Fanfold", "German Std Fanfold", "German Legal Fanfold", "B4 (ISO)", "Japanese Postcard", "9x11", "10x11", "15x11", "Envelope Invite", "Letter Extra", "Legal Extra", "A4 Extra", "Letter Transverse", "A4 Transverse", "Letter Extra Transverse", "Super A", "Super B", "Letter Plus", "A4 Plus", "A5 Transverse", "B5 (JIS) Transverse", "A3 Extra", "A5 Extra", "B5 (ISO) Extra", "A2", "A3 Transverse", "A3 Extra Transverse", "Japanese Double Postcard", "A6", "Japanese Envelope Kaku #2", "Japanese Envelope Kaku #3", "Japanese Envelope Chou #3", "Japanese Envelope Chou #4", "Letter Rotated", "A3 Rotated", "A4 Rotated", "A5 Rotated", "B4 (JIS) Rotated", "B5 (JIS) Rotated", "Japanese Postcard Rotated", "Double Japan Postcard Rotated", "A6 Rotated", "Japan Envelope Kaku #2 Rotated", "Japan Envelope Kaku #3 Rotated", "Japan Envelope Chou #3 Rotated", "Japan Envelope Chou #4 Rotated", "B6 (JIS)", "B6 (JIS) Rotated", "12x11", "Japan Envelope You #4", "Japan Envelope You #4 Rotated", "PRC Envelope #1", "PRC Envelope #3", "PRC Envelope #4", "PRC Envelope #5", "PRC Envelope #6", "PRC Envelope #7", "PRC Envelope #8", "PRC Envelope #9", "PRC Envelope #10", "PRC Envelope #1 Rotated", "PRC Envelope #3 Rotated", "PRC Envelope #4 Rotated", "PRC Envelope #5 Rotated", "PRC Envelope #6 Rotated", "PRC Envelope #7 Rotated", "PRC Envelope #8 Rotated", "PRC Envelope #9 Rotated"};
    PrinterState = 0;
    PrinterStatus = 3;
    PrintJobDataType = "RAW";
    PrintProcessor = "WinPrint";
    Priority = 1;
    Published = FALSE;
    Queued = FALSE;
    RawOnly = FALSE;
    Shared = FALSE;
    SpoolEnabled = TRUE;
    Status = "Unknown";
    SystemCreationClassName = "Win32_ComputerSystem";
    SystemName = "SERVER01";
    VerticalResolution = 600;
    WorkOffline = FALSE;
   };