Passing Parameters to a PowerShell Script

by Barry Dysert
(last updated January 9, 2017)

2

You can pass parameters to a PowerShell script two different ways. (If you don't know about PowerShell, please see the tip, "Introduction to PowerShell".) Parameters can be passed by position or by name. Both are equally valid, so let's look at how each is done.

I have a PowerShell script named LookForFiles.ps1. It looks for files in a given directory and displays those files that are greater than 20K in size. Right now my script looks like this:

$files = Get-ChildItem C:\Temp
foreach ($file in $files)
{
    if ($file.length -gt 20000)
    {
        Write-Output $file
    }
}

As you can see, my directory name (C:\Temp) and the size to check (20000) are both hard-coded. I want, instead, to pass in the directory name and size so that my script will be more flexible.

First, I'll change things so that I pass these parameters by position, i.e., the first parameter will be the directory, and the second parameter will be the size. My new script looks like this:

$files = Get-ChildItem args[0]
foreach ($file in $files)
{
    if ($file.length -gt args[1])
    {
        Write-Output $file
    }
}

Now I invoke my script and observe the output: (See Figure 1.)

Figure 1. Passing positional parameters.

Notice that when I invoke the script I pass two parameters, viz., "C:\Temp" and "20000". These are filled into "$args[0]" and "$args[1]" respectively so that the script executes exactly as before. Now let's modify the script so that it expects named parameters:

param([string] $dir = "C:\Temp", 
      [int32] $size = 20000)
$files = Get-ChildItem $dir
foreach ($file in $files)
{
    if ($file.length -gt $size)
    {
        Write-Output $file
    }
} 

Notice that I removed the references to the "$args" variables. Note too that the first line (extended to the second line) is a "param" statement. This tells PowerShell to expect named parameters. This "param" statement must be the first line in your script. It defines two variables and initializes them to default values. It defines the string variable $dir and defaults it to "C:\Temp" and it defines the int32 (numeric) variable $size and defaults it to 20000. These values are initialized with default values so that if no parameters are passed when the script is invoked, it will still run and use those values.

In place of where I used to have $args[0] I now have the $dir variable and in place of where I used to have $args[1] I now have the $size variable. Let's invoke the script, specifying these named parameters: (See Figure 2.)

Figure 2. Passing named parameters.

Now when the script is invoked I specify "-dir" followed by the directory I'm interested in, and I specify "-size" to indicate the size I'm interested in. Since these are named parameters I can reverse their order so that "-size" is specified first and "-dir" is specified second. Or I can omit them entirely and the values inside the script will be used.

 This tip (2902) applies to Windows 7, 8, and 10.

Author Bio

Barry Dysert

Barry has been a computer professional for over 35 years, working in different positions such as technical team leader, project manager, and software developer. He is currently a software engineer with an emphasis on developing custom applications under Microsoft Windows. When not working with Windows or writing Tips, Barry is an amateur writer. His first non-fiction book is titled "A Chronological Commentary of Revelation." ...

MORE FROM BARRY

How the Registry is Organized

There may come a time when you need to view or even modify the registry. In such a case, it's good to know how the ...

Discover More

Understanding DHCP

DHCP allows computers to join IP-governed networks without the need for system administrators to set up configuration ...

Discover More

Deleting Events in Your Event Logs

You don't need to worry about event logs filling up your disk, but you still may want to clean them out eventually. This ...

Discover More
More WindowsTips

Using Batch Files, Part 3: The IF Command

This tip is part of a series that talks about Windows batch files. It introduces a few more commands you can use in your ...

Discover More

Using Batch Files, Part 2

This tip is part of a series that talks about Windows batch files. It introduces a few more commands and special ...

Discover More

Using the SHIFT Statement

Sometimes your batch file needs to accept an unknown number of parameters. This is easy to deal with if you know about ...

Discover More
Subscribe

FREE SERVICE: Get tips like this every week in WindowsTips, a free productivity newsletter. Enter your address and click "Subscribe."

View most recent newsletter.

Comments

If you would like to add an image to your comment (not an avatar, but an image to help in making the point of your comment), include the characters [{fig}] in your comment text. You’ll be prompted to upload your image when you submit the comment. Maximum image size is 6Mpixels. Images larger than 600px wide or 1000px tall will be reduced. Up to three images may be included in a comment. All images are subject to review. Commenting privileges may be curtailed if inappropriate images are posted.

What is two more than 9?

2018-02-22 22:18:12

Panny

Good examples, and very nice and simple explanation


2017-01-09 13:17:26

James

These PowerShell tips are great. Keep them coming!


Newest Tips
Subscribe

FREE SERVICE: Get tips like this every week in WindowsTips, a free productivity newsletter. Enter your address and click "Subscribe."

(Your e-mail address is not shared with anyone, ever.)

View the most recent newsletter.