Edit

Share via

Remove-PrintJob

  • Reference
Module:
PrintManagement

Removes a print job on the specified printer.

Syntax

Remove-PrintJob
      [-InputObject] <CimInstance>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-PrintJob
      [-ComputerName <String>]
      [-ID] <UInt32>
      [-PrinterName] <String>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-PrintJob
      [-ID] <UInt32>
      [-PrinterObject] <CimInstance>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-PrintJob cmdlet removes a print job on the specified printer.

You can specify the print job to remove by specifying the PrinterName and job ID parameters, by specifying the printer object and job ID parameter, or by specifying a print job object as an input.

You cannot use wildcard characters with Remove-PrintJob. You can use Remove-PrintJob in a Windows PowerShell remoting session.

You do not need administrator privileges to use Remove-PrintJob.

Examples

Example 1: Remove a selected print job

PS C:\> Remove-PrintJob -PrinterName "PrinterName" -ID 1

This command removes the print job with an ID of 1 on the printer named PrinterName.

Example 2: Remove a print job using printer object and the print job ID

PS C:\> $printer = Get-Printer -PrinterName "PrinterName"
PS C:\> Remove-PrintJob -PrinterObject $printer -ID "1"

This set of commands retrieves the printer object into a variable ($printer) using Get-Printer, and then passes the contents of the variable to Remove-PrintJob to remove the print job with an ID of 1 on the printer contained in the printer object.

Example 3: Remove a print job using a print job object

PS C:\> $printJob = Get-PrintJob - PrinterName "PrinterName" -ID 1
PS C:\> Remove-PrintJob -InputObject $printJob

This set of commands retrieves the print job with an ID of 1 into a variable ($printJob) using Get-PrintJob, and then passes the contents of the variable to Remove-PrintJob to remove the print job on a printer by using a print job object.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the name of the computer on which to remove the print job.

Type:String
Aliases:CN, computer
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ID

Specifies the ID of a print job to remove on the specified printer.

Type:UInt32
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the object which contains the print job to remove on the specified printer.

Type:CimInstance
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PrinterName

Specifies a printer name on which to remove the print job.

Type:String
Aliases:PN
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PrinterObject

Specifies the object which contains the printer on which to remove the print job.

Type:CimInstance
Aliases:Printer
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

This cmdlet accepts one print job object.