Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CIM_Printer class

The CIM_Printer class represents the capabilities and management of the printer logical device.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of its inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class CIM_Printer : CIM_LogicalDevice
{
  uint16   Availability;
  string   AvailableJobSheets[];
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   Caption;
  string   CharSetsSupported[];
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  uint16   CurrentCapabilities[];
  string   CurrentCharSet;
  uint16   CurrentLanguage;
  string   CurrentMimeType;
  string   CurrentNaturalLanguage;
  string   CurrentPaperType;
  uint16   DefaultCapabilities;
  uint32   DefaultCopies;
  uint16   DefaultLanguage;
  string   DefaultMimeType;
  uint32   DefaultNumberUp;
  string   DefaultPaperType;
  string   Description;
  uint16   DetectedErrorState;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorInformation[];
  uint32   HorizontalResolution;
  datetime InstallDate;
  uint32   JobCountSinceLastReset;
  uint16   LanguagesSupported[];
  uint32   LastErrorCode;
  uint16   MarkingTechnology;
  uint32   MaxCopies;
  uint32   MaxNumberUp;
  uint32   MaxSizeSupported;
  string   MimeTypesSupported[];
  string   Name;
  string   NaturalLanguagesSupported[];
  uint16   PaperSizesSupported[];
  string   PaperTypesAvailable[];
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint16   PrinterStatus;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
  datetime TimeOfLastReset;
  uint32   VerticalResolution;
};

Members

The CIM_Printer class has these types of members:

Methods

The CIM_Printer class has these methods.

MethodDescription
Reset

Requests a reset of the logical device. Not implemented by WMI.

SetPowerState

Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI.

 

Properties

The CIM_Printer class has these properties.

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Running or Full Power

4 (0x4)

Warning

5 (0x5)

In Test

6 (0x6)

Not Applicable

7 (0x7)

Power Off

8 (0x8)

Off Line

9 (0x9)

Off Duty

10 (0xA)

Degraded

11 (0xB)

Not Installed

12 (0xC)

Install Error

13 (0xD)

Power Save - Unknown

The device is known to be in a power save mode, but its exact status is unknown.

14 (0xE)

Power Save - Low Power Mode

The device is in a power save state but still functioning, and may exhibit degraded performance.

15 (0xF)

Power Save - Standby

The device is not functioning, but could be brought to full power quickly.

16 (0x10)

Power Cycle

17 (0x11)

Power Save - Warning

The device is in a warning state, though also in a power save mode.

 

AvailableJobSheets
Data type: string array
Access type: Read-only

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

Capabilities
Data type: uint16 array
Access type: Read-only

Printer capabilities.

ValueMeaning
0

Unknown

1

Other

2

Color printing

3

Duplex printing

4

Copies

5

Collation

6

Stapling

7

Transparency printing

8

Punch

9

Cover

10

Bind

11

Black and white printing

12

One-sided

13

Two-sided long edge

14

Two-sided short edge

15

Portrait

16

Landscape

17

Reverse portrait

18

Reverse landscape

19

Quality—high

20

Quality—normal

21

Quality—low

 

CapabilityDescriptions
Data type: string array
Access type: Read-only

Free-form strings that provide 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.

Caption
Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

CharSetsSupported
Data type: string array
Access type: Read-only

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

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

Device is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

Driver for the device requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

Device is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the device uses.

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

22 (0x16)

Device is disabled.

23 (0x17)

System failure. If changing the device driver is ineffective, see the hardware documentation.

24 (0x18)

Device is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

Device is disabled. The device firmware did not provide the required resources.

30 (0x1E)

Device is using an IRQ resource that another device is using.

31 (0x1F)

Device is not working properly. Windows cannot load the required device drivers.

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

If TRUE, the device is using a user-defined configuration. This property is inherited from CIM_LogicalDevice.

CreationClassName
Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

CurrentCapabilities
Data type: uint16 array
Access type: Read-only

Finishings and other capabilities of the printer that are currently in use. Each entry in this property should also be listed in the Capabilities array.

ValueMeaning
0

Unknown

1

Other

2

Color printing

3

Duplex printing

4

Copies

5

Collation

6

Stapling

7

Transparency printing

8

Punch

9

Cover

10

Bind

11

Black and white printing

12

One-sided

13

Two-sided long edge

14

Two-sided short edge

15

Portrait

16

Landscape

17

Reverse portrait

18

Reverse landscape

19

Quality—high

20

Quality—normal

21

Quality—low

 

CurrentCharSet
Data type: string
Access type: Read-only

Current character set used for the output of text relating to management of the printer. The character set described by this property should also be listed in the CharsetsSupported property. 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".

CurrentLanguage
Data type: uint16
Access type: Read-only

Current printer language being used; the language should also be listed in the LanguagesSupported property.

ValueMeaning
1

Other

2

Unknown

3

PCL

4

HPGL

5

PJL

6

PS

7

PSPrinter

8

IPDS

9

PPDS

10

EscapeP

11

Epson

12

DDIF

13

Interpress

14

ISO6429

15

Line Data

16

MODCA

17

REGIS

18

SCS

19

SPDL

20

TEK4014

21

PDS

22

IGP

23

CodeV

24

DSCDSE

25

WPS

26

LN03

27

CCITT

28

QUIC

29

CPAP

30

DecPPL

31

Simple Text

32

NPAP

33

DOC

34

imPress

35

Pinwriter

36

NPDL

37

NEC201PL

38

Automatic

39

Pages

40

LIPS

41

TIFF

42

Diagnostic

43

CaPSL

44

EXCL

45

LCDS

46

XES

47

MIME

 

CurrentMimeType
Data type: string
Access type: Read-only

Mime type currently in use by the printer when the CurrentLanguage property is set to indicate that a mime type is in use.

CurrentNaturalLanguage
Data type: string
Access type: Read-only

Current language in use by the printer for management. The language listed here should also be listed in NaturalLanguagesSupported.

CurrentPaperType
Data type: string
Access type: Read-only

Paper type currently in use by the printer. 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).

DefaultCapabilities
Data type: uint16
Access type: Read-only

Default finishings and other capabilities of the printer. Each entry in this property should also be listed in the Capabilities array.

ValueMeaning
0

Unknown

1

Other

2

Color printing

3

Duplex printing

4

Copies

5

Collation

6

Stapling

7

Transparency printing

8

Punch

9

Cover

10

Bind

11

Black and white printing

12

One-sided

13

Two-sided long edge

14

Two-sided short edge

15

Portrait

16

Landscape

17

Reverse portrait

18

Reverse landscape

19

Quality—high

20

Quality—normal

21

Quality—low

 

DefaultCopies
Data type: uint32
Access type: Read-only

Number of copies that a single job will produce, unless otherwise specified.

DefaultLanguage
Data type: uint16
Access type: Read-only

Default printer language. The language should also be listed in the LanguagesSupported property.

ValueMeaning
1

Other

2

Unknown

3

PCL

4

HPGL

5

PJL

6

PS

7

PSPrinter

8

IPDS

9

PPDS

10

EscapeP

11

Epson

12

DDIF

13

Interpress

14

ISO6429

15

Line Data

16

MODCA

17

REGIS

18

SCS

19

SPDL

20

TEK4014

21

PDS

22

IGP

23

CodeV

24

DSCDSE

25

WPS

26

LN03

27

CCITT

28

QUIC

29

CPAP

30

DecPPL

31

Simple Text

32

NPAP

33

DOC

34

imPress

35

Pinwriter

36

NPDL

37

NEC201PL

38

Automatic

39

Pages

40

LIPS

41

TIFF

42

Diagnostic

43

CaPSL

44

EXCL

45

LCDS

46

XES

47

MIME

 

DefaultMimeType
Data type: string
Access type: Read-only

Default mime type used by the printer when the DefaultLanguage property is set to indicate that a mime type is in use.

DefaultNumberUp
Data type: uint32
Access type: Read-only

Number of print-stream pages that the printer will render onto a single media sheet, unless a job specifies otherwise.

DefaultPaperType
Data type: string
Access type: Read-only

Paper type that the printer will use if 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).

Description
Data type: string
Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedSystemElement.

DetectedErrorState
Data type: uint16
Access type: Read-only

Printer error information.

ValueMeaning
0

Unknown

1

Other

2

No error

3

Low paper

4

No paper

5

Low toner

6

No toner

7

Door open

8

Jammed

9

Offline

10

Service requested

11

Output bin full

 

DeviceID
Data type: string
Access type: Read-only

Address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice.

ErrorCleared
Data type: boolean
Access type: Read-only

If TRUE, the error reported in the LastErrorCode property is now cleared. This property is inherited from CIM_LogicalDevice.

ErrorDescription
Data type: string
Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform. This property is inherited from CIM_LogicalDevice.

ErrorInformation
Data type: string array
Access type: Read/write

Array that provides supplemental information for the current error state, indicated in the DetectedErrorState property.

HorizontalResolution
Data type: uint32
Access type: Read-only

Horizontal resolution in pixels-per-inch.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

JobCountSinceLastReset
Data type: uint32
Access type: Read-only

Printer jobs processed since the last reset. These jobs can be processed from one or more print queues.

LanguagesSupported
Data type: uint16 array
Access type: Read-only

Print languages that are natively supported.

ValueMeaning
1

Other

2

Unknown

3

PCL

4

HPGL

5

PJL

6

PS

7

PSPrinter

8

IPDS

9

PPDS

10

EscapeP

11

Epson

12

DDIF

13

Interpress

14

ISO6429

15

Line Data

16

MODCA

17

REGIS

18

SCS

19

SPDL

20

TEK4014

21

PDS

22

IGP

23

CodeV

24

DSCDSE

25

WPS

26

LN03

27

CCITT

28

QUIC

29

CPAP

30

DecPPL

31

Simple Text

32

NPAP

33

DOC

34

imPress

35

Pinwriter

36

NPDL

37

NEC201PL

38

Automatic

39

Pages

40

LIPS

41

TIFF

42

Diagnostic

43

CaPSL

44

EXCL

45

LCDS

46

XES

47

MIME

 

LastErrorCode
Data type: uint32
Access type: Read-only

Last error code reported by the logical device. This property is inherited from CIM_LogicalDevice.

MarkingTechnology
Data type: uint16
Access type: Read-only

Marking technology used by the printer.

ValueMeaning
1

Other

2

Unknown

3

Electrophotographic LED

4

Electrophotographic Laser

5

Electrophotographic Other

6

Impact Moving Head Dot Matrix 9pin

7

Impact Moving Head Dot Matrix 24pin

8

Impact Moving Head Dot Matrix Other

9

Impact Moving Head Fully Formed

10

Impact Band

11

Impact Other

12

Inkjet Aqueous

13

Inkjet Solid

14

Inkjet Other

15

Pen

16

Thermal Transfer

17

Thermal Sensitive

18

Thermal Diffusion

19

Thermal Other

20

Electroerosion

21

Electrostatic

22

Photographic Microfiche

23

Photographic Imagesetter

24

Photographic Other

25

Ion Deposition

26

eBeam

27

Typesetter

 

MaxCopies
Data type: uint32
Access type: Read-only

Maximum number of copies that can be produced by the printer from a single job.

MaxNumberUp
Data type: uint32
Access type: Read-only

Maximum number of print-stream pages that the printer can render onto a single media sheet.

MaxSizeSupported
Data type: uint32
Access type: Read-only

Largest job (as a byte stream) that the printer will accept in units of kilobytes. A value of 0 (zero) indicates that no limit has been set.

MimeTypesSupported
Data type: string array
Access type: Read-only

Free-form strings that provide detailed explanations of 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.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NaturalLanguagesSupported
Data type: string array
Access type: Read-only

Available languages for strings used by the printer for management information output. The strings should conform to RFC 1766. For example, "en" is used for English.

PaperSizesSupported
Data type: uint16 array
Access type: Read-only

Types of paper supported.

ValueMeaning
0

Unknown

1

Other

2

A

3

B

4

C

5

D

6

E

7

Letter

8

Legal

9

NA-10x13-Envelope

10

NA-9x12-Envelope

11

NA-Number-10-Envelope

12

NA-7x9-Envelope

13

NA-9x11-Envelope

14

NA-10x14-Envelope

15

NA-Number-9-Envelope

16

NA-6x9-Envelope

17

NA-10x15-Envelope

18

A0

19

A1

20

A2

21

A3

22

A4

23

A5

24

A6

25

A7

26

A8

27

A9A10

28

B0

29

B1

30

B2

31

B3

32

B4

33

B5

34

B6

35

B7

36

B8

37

B9

38

B10

39

C0

40

C1

41

C2C3

42

C4

43

C5

44

C6

45

C7

46

C8

47

ISO-Designated

48

JIS B0

49

JIS B1

50

JIS B2

51

JIS B3

52

JIS B4

53

JIS B5

54

JIS B6

55

JIS B7

56

JIS B8

57

JIS B9

58

JIS B10

59

NA-Letter

60

NA-Legal

61

B4-Envelope

62

B5-Envelope

63

C3-Envelope

64

C4-Envelope

65

C5-Envelope

66

C6-Envelope

67

Designated-Long-Envelope

68

Monarch-Envelope

69

Executive

70

Folio

71

Invoice

72

Ledger

73

Quarto

 

PaperTypesAvailable
Data type: string array
Access type: Read-only

Free-form strings that specify the types of paper that are currently available for 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 the PaperTypesAvailable property should also appear in the PaperSizesSupported property.

PNPDeviceID
Data type: string
Access type: Read-only

Win32 Plug and Play device identifier of the logical device. This property is inherited from CIM_LogicalDevice.

Example: "*PNP030b"

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.

ValueMeaning
0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

4 (0x4)

Power Saving Modes Entered Automatically

The device can change its power state based on usage or other criteria.

5 (0x5)

Power State Settable

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

6 (0x6)

Power Cycling Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

7 (0x7)

Timed Power On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only

If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array. This property is inherited from CIM_LogicalDevice.

PrinterStatus
Data type: uint16
Access type: Read-only

Status information, beyond that specified in the Availability property, for a printer.

ValueMeaning
1

Other

2

Unknown

3

Idle

4

Printing

5

Warmup

6

Stopped printing

7

Offline

 

Status
Data type: string
Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInfo
Data type: uint16
Access type: Read-only

State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Enabled

4 (0x4)

Disabled

5 (0x5)

Not Applicable

 

SystemCreationClassName
Data type: string
Access type: Read-only

Scoping system's creation class name. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Scoping system's name. This property is inherited from CIM_LogicalDevice.

TimeOfLastReset
Data type: datetime
Access type: Read-only

Time of last printer reset.

VerticalResolution
Data type: uint32
Access type: Read-only

Vertical resolution in pixels-per-inch.

Remarks

The CIM_Printer class is derived from CIM_LogicalDevice.

WMI does not implement this class. For WMI classed derived from CIM_Printer, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Show:
© 2014 Microsoft