10/18/21

PowerShell Functions begin with the basics

PowerShell functions are reusable code blocks that allow you to group a set of PowerShell commands together and execute them as a single unit. Functions are a fundamental building block of PowerShell scripts and are useful for reducing code duplication, improving code organization, and making your scripts more modular and maintainable. Here's how PowerShell functions work:

Defining a function: To create a function in PowerShell, you use the function keyword followed by the name of the function, a set of parentheses, and a set of curly braces. Inside the curly braces, you can include any number of PowerShell commands that you want the function to execute. For example, here is a simple function called HelloWorld that outputs the message "Hello, World!" to the console:

function HelloWorld {

Write-Host "Hello, World!"

}

Invoking a function: Once you have defined a function, you can invoke it by typing its name followed by a set of parentheses. For example, to invoke the HelloWorld function from the previous example, you would use the following command:

HelloWorld

This would output the message "Hello, World!" to the console.

Passing parameters to a function: Functions in PowerShell can also accept parameters, which are values that are passed to the function when it is invoked. To define a function with parameters, you include the parameter names inside the parentheses when defining the function, like this:

function Greet($name) {

Write-Host "Hello, $name!"

}

In this example, the Greet function accepts a single parameter called $name. When the function is invoked, you pass a value for the $name parameter, like this:

Greet "John"

This would output the message "Hello, John!" to the console.

Returning values from a function: Functions in PowerShell can also return values, which can be used in other parts of your script. To return a value from a function, you use the return keyword followed by the value you want to return. For example, here is a function called Add that adds two numbers and returns the result:

function Add($a, $b) {

return $a + $b

}

To use the Add function and capture its return value, you can assign the function call to a variable, like this:

$result = Add 2 3

Write-Host "The result is $result"

This would output the message "The result is 5" to the console.

Overall, PowerShell functions are a powerful tool for building modular, reusable code in your scripts. They allow you to encapsulate complex logic and functionality, and make your code more organized, maintainable, and reusable.

Previous

Discover the Secrets of PowerShell Help: Get-Help & Get-Alias Uncovered"

Next

Step-by-Step: Building & Leveraging PowerShell Modules with PSGallery