{"id":53703,"date":"2009-05-21T15:25:00","date_gmt":"2009-05-21T15:25:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2009\/05\/21\/hey-scripting-guy-how-can-i-perform-more-than-one-action-with-the-win32_printer-wmi-class\/"},"modified":"2009-05-21T15:25:00","modified_gmt":"2009-05-21T15:25:00","slug":"hey-scripting-guy-how-can-i-perform-more-than-one-action-with-the-win32_printer-wmi-class","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/hey-scripting-guy-how-can-i-perform-more-than-one-action-with-the-win32_printer-wmi-class\/","title":{"rendered":"Hey, Scripting Guy! How Can I Perform More Than One Action with the Win32_Printer WMI Class?"},"content":{"rendered":"

\"Hey, <\/h2>\n

Hey, Scripting Guy! The Win32_Printer<\/b> WMI class has several methods that are listed in it. But I am not sure how to best use these methods from inside a Windows PowerShell script. I do not want to create four different scripts to send a test page, clean out print jobs, and to cycle the print queue. Do you have an example of how I might do more than one action in a script?<\/p>\n

– AA<\/p>\n

\"Spacer\"\"Hey, <\/p>\n

Hi AA,<\/p>\n

Ed is relaxing after a long hard week of working at Tech\u2219Ed. His talk was a success, and he is resting on his laurels. He feels that he might be able to milk it for at least another week. In fact, he is sitting with his feet propped up listening to Mac Davis<\/a> on his Zune. Mac Davis, he feels, goes well with green tea with a hint of jasmine. If we can get his attention, perhaps he might return to work.<\/p>\n\n<\/thead>\n\n\n
\n

This week we will examine printing. There are lots of resources related to printing on the TechNet Script Center. There is a collection of Hey, Scripting Guy! articles<\/a> that lists 24 articles relates to both server-side and client-side printing. We have almost 50 scripts in the printer section<\/a> of the Script Center Script Repository<\/a>. There are also almost 50 scripts in the printer section<\/a> of the Community-Submitted Scripts Center. We have some good technical information about printing in the Scripting Guide<\/a>. All those resources are in VBScript. To use them in Windows PowerShell, you would have to translate the scripts into PowerShell. The Microsoft Press book, Windows PowerShell Scripting Guide<\/a>, has a whole chapter devoted to printing.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/div>\n

Well, AA, you are in luck, we have Ed\u2019s attention. Ed loves writing scripts that perform multiple actions. To do this, he uses command-line parameters. The ManagePrinter.ps1<\/b> script shows how to call multiple printer functions. You can call it by using command lines similar to this. Each command line allows you to access a different functionality provided by the ManagePrinter.ps1<\/b> script. The five different combinations allow you to perform routine tasks such as sending a test page, stopping print jobs, pausing, and resuming the printer.<\/p>\n

# List local printers on the localhost.\\ManagePrinter.ps1 -list -computer localhost# Send a test page to a printer named testprinter on the localhost .\\ManagePrinter.ps1 -computer localhost -sendTestPage -printerPath testprinter# Cancel all print jobs on the testprinter on the localhost.\\ManagePrinter.ps1 -computer localhost -stopPrintJobs -printerPath testprinter# Resume printing on the testprinter on the localhost.\\ManagePrinter.ps1 -computer localhost -printerPath testprinter \u2013resume# suspend printing on the testprinter on the localhost.\\ManagePrinter.ps1 -computer localhost -printerPath testprinter \u2013suspend<\/pre>\n
The complete ManagePrinter.ps1<\/b> script is seen here:<\/p>\n
ManagePrinter.ps1<\/b><\/p>\n
Param(            $computer,             $printerPath,             [switch]$list,             [switch]$sendTestPage,            [switch]$stopPrintJobs,            [switch]$suspend,            [switch]$resume)Function Get-Printer($computer){ Get-WmiObject -class Win32_Printer -computer $computer} #end Get-PrinterFunction Format-Printer($printObject){ Write-Host -foregroundcolor cyan \"Shared printers on $computer\" $printObject |  Where-Object { $_.sharename } | Format-Table -property sharename, location, comment -autosize -wrap} #end Format-PrinterFunction Get-SuccessCode($code){ if($code.ReturnValue -eq 0)  { Write-Host -foregroundcolor green \"Operation suceeded!\" } Else  { Write-Host -foregroundcolor red \"Operation failed with $($code.returnvalue)\" }} #end get-successcodeFunction Send-TestPage($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Sending test page to $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.PrintTestPage()} #end Send-TestPageFunction Stop-AllPrintJobs($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Cancelling all print jobs on $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.CancelAllJobs()} #end Stop-AllPrintJobsFunction Suspend-Printer($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Suspending printing on $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.Pause()} #end Suspend-PrinterFunction Resume-Printer($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Resuming printing on $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.Resume()} #end Resume-Printer# *** Entry Point to Script ***if($list) { Format-Printer(Get-Printer($computer)) ; exit }if($sendTestPage) {   Get-SuccessCode -code `   (Send-TestPage -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit }if($stopPrintJobs) {   Get-SuccessCode -code `   (Stop-AllPrintJobs -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit }if($suspend) {   Get-SuccessCode -code `   (Suspend-Printer -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit }if($resume) {   Get-SuccessCode -code `   (Resume-Printer -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit }<\/pre>\n
The first thing the ManagePrinter.ps1<\/b> script does is create a number of parameters. The \u2013computer<\/b> parameter holds the name of the destination computer, and the \u2013printerpath<\/b> parameter holds the name of the printer. The other parameters are switched parameters that are used to obtain access to different functions within the script. The param<\/b> statement is seen here:<\/p>\n
Param(            $computer,             $printerPath,             [switch]$list,             [switch]$sendTestPage,            [switch]$stopPrintJobs,            [switch]$suspend,            [switch]$resume)<\/pre>\n
The first function, the Get-Printer<\/b> function, is the same as the Get-Printer<\/b> function from Tuesday’s article<\/a>:<\/p>\n
Function Get-Printer($computer){Get-WmiObject -class Win32_Printer -computer $computer} #end Get-Printer<\/pre>\n
The second function, the Format-Printer<\/b> function, is also the same as the Format-Printer<\/b> function from Tuesday’s article:<\/p>\n
Function Format-Printer($printObject){Write-Host -foregroundcolor cyan \"Shared printers on $computer\"$printObject | Where-Object { $_.sharename } |Format-Table -property sharename, location, comment -autosize -wrap} #end Format-Printer<\/pre>\n
We now come to the Get-SuccessCode<\/b> function. Guess what? It is also the same as the Get-SuccessCode<\/b> function from Tuesday (please refer to Tuesday\u2019s \u201cHey, Scripting Guy!\u201d article<\/a> for a discussion of that function):<\/p>\n
Function Get-SuccessCode($code){if($code.ReturnValue -eq 0)  { Write-Host -foregroundcolor green \"Operation suceeded!\" }Else  { Write-Host -foregroundcolor red \"Operation failed with $($code.returnvalue)\" }} #end get-successcode<\/pre>\n
Now we arrive at something new. The Send-TestPage<\/b> function is used to send a test page to a printer. When this function is called, it is passed a WMI Win32_Printer<\/b> object (which is returned by the Get-Printer<\/b> function) in addition to the name of the printer that will receive the test page. The first thing the Send-TestPage<\/b> function does is display a message that states it is sending a test page to the printer designated by the string contained in the $printerPath<\/b> variable. The WMI Win32_Printer<\/b> object is pipelined to the Where-Object<\/b> cmdlet. Inside the script block for the Where-Object<\/b>, the deviceID<\/b> property of each printer in the collection of printers is searched to see whether it matches the string contained in the $printerPath<\/b> variable. If a match is found, the printer object is held in the $dp<\/b> variable. The PrintTestPage<\/b> method is called from the Win32_Printer<\/b> WMI object that is stored in the $dp<\/b> variable. The complete Send-TestPage<\/b> function is shown here:<\/p>\n
Function Send-TestPage($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Sending test page to $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.PrintTestPage()} #end Send-TestPage<\/pre>\n
The command line to send a test page to a printer specifies the name of the computer, the sendtestpage<\/b> switched parameter, and the name of the printer. This is seen here:<\/p>\n
.\\ManagePrinter.ps1 -computer localhost -sendTestPage -printerPath testprinter<\/pre>\n
When the ManagePrinter.ps1<\/b> script starts with the previous command line, this is displayed:<\/p>\n
\"Image <\/p>\n
 <\/p>\n
If the ManagePrinter.ps1<\/b> script is run with the StopPrintJobs<\/b> parameter, it calls the Stop-AllPrintJobs<\/b> function. The command line to call the Stop-AllPrintJobs<\/b> function is seen here:<\/p>\n
.\\ManagePrinter.ps1 -computer localhost -stopprintjobs -printerPath testprinter<\/pre>\n
When the Stop-AllPrintJobs<\/b> function is called, it receives the Win32_Printer<\/b> object that is contained in the $printObject<\/b> variable and the path of the printer whose print jobs are to be canceled. The syntax of the Stop-AllPrintJobs<\/b> function resembles the SendTestPage<\/b> function except that the Stop-AllPrintJobs<\/b> function calls the CancelAllJobs<\/b> method from the Win32_Printer<\/b> object that is contained in the $dp<\/b> variable. The Stop-AllPrintJobs<\/b> function is seen here:<\/p>\n
Function Stop-AllPrintJobs($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Canceling all print jobs on $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.CancelAllJobs()} #end Stop-AllPrintJobs<\/pre>\n
If you have to suspend printing, you call the Suspend-Printer<\/b> function and pass the Win32_Printer<\/b> object and the path to the printer that will be paused. When you start the ManagePrinter.ps1<\/b> script to pause printing, you would use this command-line syntax:<\/p>\n
.\\ManagePrinter.ps1 -computer localhost -printerPath testprinter \u2013suspend<\/pre>\n
In the Suspend-Printer<\/b> function, the first thing that happens is a message is displayed that states printing is being suspended on the target printer. The Win32_Printer<\/b> WMI object is pipelined to the Where-Object<\/b> where it is filtered based on the deviceID<\/b> property. The resulting object is used to call the pause<\/b> method. This is seen here:<\/p>\n
Function Suspend-Printer($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Suspending printing on $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath }  $dp.Pause()} #end Suspend-Printer<\/pre>\n
When the ManagePrinter.ps1<\/b> script is used to suspend printing, the target printer\u2019s status changes to paused:<\/p>\n
\"Image <\/p>\n
 <\/p>\n
To resume printing, you call the Resume-Printer<\/b> function. This function works the same as the Suspend-Printer<\/b> function because it accepts two parameters. The first parameter is the Win32_Printer<\/b> object that is contained in the $printObject<\/b> variable, and the other is the name of the printer stored in the $printerPath<\/b> variable. The resume<\/b> method is called from the printer object. To resume printing by using the ManagePrinter.ps1<\/b> script, you would use this command line:<\/p>\n
.\\ManagePrinter.ps1 -computer localhost -printerPath testprinter \u2013resume<\/pre>\n
The complete Resume-Printer<\/b> function is seen here:<\/p>\n
Function Resume-Printer($printObject, [string]$printerPath){  Write-Host -foregroundcolor cyan \"Resuming printing on $printerPath\"  $dp = $printObject |  Where-Object { $_.deviceID -match $printerPath } $dp.Resume()} #end Resume-Printer<\/pre>\n
The entry point to the script is used to examine the command line parameters. If the \u2013list<\/b> parameter is specified, the Get-Printer<\/b> function is called by using the computer name that is contained in the $computer<\/b> variable. The resulting management object is passed to the Format-Printer<\/b> function and the script exits. This is seen here:<\/p>\n
if($list) { Format-Printer(Get-Printer($computer)) ; exit }<\/pre>\n
If the \u2013sendTestPage<\/b> switched parameter is used on the command line, the Get-Printer<\/b> function is called and the resulting management object is passed to the Send-Test<\/b>P<\/b>age<\/b> function by using the \u2013printObject<\/b> parameter:<\/p>\n
if($sendTestPage){   Get-SuccessCode -code `   (Send-TestPage -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit }<\/pre>\n
If the \u2013stopPrintJobs<\/b> switched parameter is used, the Get-Printer<\/b> function is used to retrieve a Win32_Printer<\/b> management object, which is passed to the Stop-AllPrintJobs<\/b> function through the \u2013printObject<\/b> parameter. The target printer is passed via the \u2013printerPath<\/b> parameter. The return value from calling the Stop-AllPrintJobs<\/b> function is parsed by the Get-SuccessCode<\/b> function. This is seen here:<\/p>\n
if($stopPrintJobs){   Get-SuccessCode -code `   (Stop-AllPrintJobs -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit}<\/pre>\n
If the script is run with the \u2013suspend<\/b> switched parameter, the Get-Printer<\/b> function is used to return a Win32_Printer<\/b> object, which is passed to the Suspend-Printer<\/b> function through the \u2013printObject<\/b> parameter. The path of the printer is passed to the Suspend-Printer<\/b> function through the \u2013printerpath<\/b> parameter. The return value is evaluated by the Get-SuccessCode<\/b> function through the \u2013code<\/b> parameter. This is shown here:<\/p>\n
if($suspend) {   Get-SuccessCode -code `   (Suspend-Printer -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit}<\/pre>\n
If the script is started with the \u2013resume<\/b> parameter, the first thing that happens is the Get-Printer<\/b> function is used to create a Win32_Printer<\/b> WMI management object, which is passed to the Resume-Printer<\/b> function through the \u2013printobject<\/b> parameter. The name of the printer is passed to the Resume-Printer<\/b> function through the \u2013printerpath<\/b> parameter. The Get-SuccessCode<\/b> function is used to evaluate the return value. This is seen here:<\/p>\n
if($resume){   Get-SuccessCode -code `   (Resume-Printer -printObject(Get-Printer($computer)) -printerPath $printerPath)   exit}<\/pre>\n
Well, AA, we come to the end of the ManagePrinter.ps1 <\/b>script. It is also the end of Printing Week on the Script Center. Join us tomorrow for Quick-Hits Friday as we answer several short e-mail messages that cover a variety of topics. Until then, take care and we\u2019ll see you over the weekend and next week.<\/p>\n
 <\/p>\n
Ed Wilson and Craig Liebendorfer, Scripting Guys<\/b><\/p>\n","protected":false},"excerpt":{"rendered":"
Hey, Scripting Guy! The Win32_Printer WMI class has several methods that are listed in it. But I am not sure how to best use these methods from inside a Windows PowerShell script. I do not want to create four different scripts to send a test page, clean out print jobs, and to cycle the print […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[445,404,3,5,45],"class_list":["post-53703","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-client-side-printing","tag-printing","tag-scripting-guy","tag-vbscript","tag-windows-powershell"],"acf":[],"blog_post_summary":"
Hey, Scripting Guy! The Win32_Printer WMI class has several methods that are listed in it. But I am not sure how to best use these methods from inside a Windows PowerShell script. I do not want to create four different scripts to send a test page, clean out print jobs, and to cycle the print […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/53703","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=53703"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/53703\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=53703"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=53703"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=53703"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}