image/svg+xml image/svg+xml Layer 1 Layer 2 background powershell.one
  • Feb 29, 2020

Win32_PrintJob

The Win32_PrintJob WMI class represents a print job generated by a Windows application. Any unit of work generated by the print command of an application that is running on a computer running on a ...

The Win32_PrintJob WMI class represents a print job generated by a Windows application. Any unit of work generated by the print command of an application that is running on a computer running on a Windows operating system is a descendant or member of this class.

Methods

Win32_PrintJob has 2 methods:
Method Description
Pause Pauses a print job.
Resume Continues a print job.

Learn more about Invoke-CimMethod and how to invoke commands. Click any of the methods listed above to learn more about their purpose, parameters, and return value.

Properties

Win32_PrintJob returns 28 properties:

'Caption','Color','DataType','Description','Document','DriverName','ElapsedTime',
'HostPrintQueue','InstallDate','JobId','JobStatus','Name','Notify','Owner','PagesPrinted','PaperLength',
'PaperSize','PaperWidth','Parameters','PrintProcessor','Priority','Size','StartTime','Status',
'StatusMask','TimeSubmitted','TotalPages','UntilTime'

Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:

Get-CimInstance -ClassName Win32_PrintJob -Property *

Most WMI classes return one or more instances.

When Get-CimInstance returns no result, then apparently no instances of class Win32_PrintJob exist. This is normal behavior.

Either the class is not implemented on your system (may be deprecated or due to missing drivers, i.e. CIM_VideoControllerResolution), or there are simply no physical representations of this class currently available (i.e. Win32_TapeDrive).

Caption

STRING MAX 64 CHAR

A short textual description of the object.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Caption

Color

STRING

String that indicates whether the document is printed in color or monochrome. Some color printers have the capability to print using true black instead of a combination of yellow, cyan, and magenta. True black usually creates darker and sharper text for documents. This option is only useful for color printers that support true black printing.

The values are:

“Color”

“Monochrome”

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Color

DataType

STRING

Format of the data for this print job. This instructs the printer driver to translate the data (generic text, PostScript, or PCL) before printing, or print in a raw format (for graphics and pictures).

Example: “TEXT”

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property DataType

Description

STRING

A textual description of the object.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Description

Document

STRING

Name of the print job. The user sees this name when viewing documents that are waiting to be printed.

Example: “Microsoft Word - Review.doc”

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Document

DriverName

STRING

Name of the printer driver used for the print job.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property DriverName

ElapsedTime

DATETIME

Length of time the job has been executing.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property ElapsedTime

HostPrintQueue

STRING

Name of the computer on which the print job is created.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property HostPrintQueue

InstallDate

DATETIME

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property InstallDate

JobId

UINT32

Identifier number of the job. It is used by other methods as a handle to a job spooling to the printer.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property JobId

JobStatus

STRING

Free-form string that represents the job status.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property JobStatus

Name

STRING

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

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Name

Notify

STRING

User is notified upon job completion or failure.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Notify

Owner

STRING

User who submitted the job.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Owner

PagesPrinted

UINT32

Number of pages that are printed. This value may be 0 (zero) if the print job does not contain page-delimiting information.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property PagesPrinted

PaperLength

UINT32 TENTHS OF A MILLIMETER.

Length of the paper.

Example: 2794

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property PaperLength

PaperSize

STRING

Size of the paper used to print the job. The value is one of the possible paper sizes for the printer specified in the PaperSizesSupported property of Win32_Printer class.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property PaperSize

PaperWidth

UINT32 TENTHS OF A MILLIMETER.

Width of the paper.

Example: 2159

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property PaperWidth

Parameters

STRING

Optional parameters to send to the print processor. For more information, see the PrintProcessor property.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Parameters

PrintProcessor

STRING

Print processor service used to process the print job. A printer processor works in conjunction with the printer driver to provide additional translation of printer data for the printer, and can also be used to provide special options, such as a title page for the job.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property PrintProcessor

Priority

UINT32

Importance of a job’s execution.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Priority

Size

UINT32 BYTES

Size of the print job.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Size

StartTime

DATETIME

Time that the job began.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property StartTime

Status

STRING MAX 10 CHAR

Current status of an object. Various operational and nonoperational statuses can be defined. Available values:

$values = 'Degraded','Error','Lost Comm','No Contact','NonRecover','OK','Pred Fail','Service','Starting','Stopping','Stressed','Unknown'

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property Status

StatusMask

UINT32

Bitmap of the possible statuses that relate to this print job.

1 (0x1)

Paused

2 (0x2)

Error

4 (0x4)

Deleting

8 (0x8)

Spooling

16 (0x10)

Printing

32 (0x20)

Offline

64 (0x40)

Paperout

128 (0x80)

Printed

256 (0x100)

Deleted

512 (0x200)

Blocked_DevQ

1024 (0x400)

User_Intervention_Req

2048 (0x800)

Restart

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property StatusMask

TimeSubmitted

DATETIME

Time that the job was submitted.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property TimeSubmitted

TotalPages

UINT32

Number of pages required to complete the job. This value may be 0 (zero) if the print job does not contain page-delimiting information.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property TotalPages

UntilTime

DATETIME

Time at which the job is invalid or should be stopped.

Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property UntilTime

Examples

List all instances of Win32_PrintJob 
Get-CimInstance -ClassName Win32_PrintJob

Learn more about Get-CimInstance and the deprecated Get-WmiObject.

View all properties 
Get-CimInstance -ClassName Win32_PrintJob -Property *
View key properties only 
Get-CimInstance -ClassName Win32_PrintJob -KeyOnly

Selecting Properties

To select only some properties, pipe the results to Select-Object -Property a,b,c with a comma-separated list of the properties you require. Wildcards are permitted.

Get-CimInstance always returns all properties but only retrieves the ones that you specify. All other properties are empty but still present. That’s why you need to pipe the results into Select-Object if you want to limit the visible properties, i.e. for reporting.

Selecting Properties

The code below lists all available properties. Remove the ones you do not need:

$properties = 'Caption',
              'Color',
              'DataType',
              'Description',
              'Document',
              'DriverName',
              'ElapsedTime',
              'HostPrintQueue',
              'InstallDate',
              'JobId',
              'JobStatus',
              'Name',
              'Notify',
              'Owner',
              'PagesPrinted',
              'PaperLength',
              'PaperSize',
              'PaperWidth',
              'Parameters',
              'PrintProcessor',
              'Priority',
              'Size',
              'StartTime',
              'Status',
              'StatusMask',
              'TimeSubmitted',
              'TotalPages',
              'UntilTime'
Get-CimInstance -ClassName Win32_PrintJob | Select-Object -Property $properties
Limiting Network Bandwidth

If you work remotely, it makes sense to limit network bandwidth by filtering the properties on the server side, too:

Get-CimInstance -Class Win32_PrintJob -Property $property | 
Select-Object -Property $property

Selecting Instances

To select some instances, use Get-CimInstance and a WMI Query. The wildcard character in WMI Queries is % (and not “*”).

The parameter -Filter runs a simple query.

Listing all instances where the property Caption starts with “A” 
Get-CimInstance -Class Win32_PrintJob -Filter 'Caption LIKE "a%"'
Using a WQL Query

The parameter -Query uses a query similar to SQL and combines the parameters -Filter and -Property. This returns all instances where the property Caption starts with “A”, and returns the properties specified:

Get-CimInstance -Query "SELECT TimeSubmitted, Size, DataType, Name FROM Win32_PrintJob WHERE Caption LIKE 'a%'"

Any property you did not specify is still present but empty. You might need to use Select-Object to remove all unwanted properties:

Get-CimInstance -Query "SELECT TimeSubmitted, Size, DataType, Name FROM Win32_PrintJob WHERE Caption LIKE 'a%'" | Select-Object -Property TimeSubmitted, Size, DataType, Name

Accessing Remote Computers

To access remote systems, you need to have proper permissions. User the parameter -ComputerName to access one or more remote systems.

Authenticating as Current User 
# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with your current identity:
$result = Get-CimInstance -ClassName Win32_PrintJob -ComputerName $list 
$result
Authenticating as Different User

Use a CIMSession object to authenticate with a new identity:

# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with a different identity:
$cred = Get-Credential -Message 'Authenticate to retrieve WMI information:'
$session = New-CimSession -ComputerName $list -Credential $cred

$result = Get-CimInstance Win32_PrintJob -CimSession $session

# remove the session after use (if you do not plan to re-use it later)
Remove-CimSession -CimSession $session

$result

Learn more about accessing remote computers.

Requirements

To use Win32_PrintJob, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_PrintJob was introduced on clients with Windows Vista and on servers with Windows Server 2008.

Namespace

Win32_PrintJob lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_PrintJob is implemented in CIMWin32.dll and defined in Win32_Printer.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\Win32_Printer.mof
© powershell.one 2020 - Legal - Contact Us