带参数的 PowerShell 函数示例

作为一名 PowerShell 开发人员，您应该知道如何在 PowerShell 函数中使用参数。在本教程中，我将向您展示如何创建带参数的 PowerShell 函数，包括单个参数和多个参数。

带参数的 PowerShell 函数

让我们从接受单个参数的 PowerShell 函数的简单示例开始。当您需要将单个数据传递给 PowerShell 函数时，这会很有用。

句法

具有单个参数的 PowerShell 函数的基本语法如下：

function Function-Name {
    param (
        [ParameterType]$ParameterName
    )

    # Function logic here
}

例子

让我们在 PowerShell 中创建一个函数，该函数将名称作为参数并打印问候消息。

function Greet-User {
    param (
        [string]$Name
    )

    Write-Output "Hello, $Name!"
}

# Calling the function
Greet-User -Name "Alice"

它的工作原理如下：

1. 函数定义：函数Greet-User是使用function关键字定义的。
2. 参数定义：param块用于定义参数。在这里，我们定义了一个 [string] 类型的参数 $Name。
3. 函数逻辑：Write-Output cmdlet 用于打印包含 $Name 参数值的问候消息。
4. 函数调用：使用-Name参数调用函数，并传递值“Alice”。

我已经使用 VS code 执行了上述 PowerShell 脚本，您可以在下面的屏幕截图中看到输出：

阅读如何在 PowerShell 中使用 Try-Catch 处理错误？

具有多个参数的 PowerShell 函数

有时，您需要将多个参数传递给 PowerShell 函数。 PowerShell 可以轻松定义具有多个参数的函数。

句法

具有多个参数的 PowerShell 函数的语法与单参数函数的语法类似，但在 param 块中定义了多个参数。

function Function-Name {
    param (
        [ParameterType1]$ParameterName1,
        [ParameterType2]$ParameterName2
    )

    # Function logic here
}

例子

下面是一个完整的示例，用于创建一个函数，该函数采用两个参数：名称和年龄，并打印一条消息。

function Introduce-User {
    param (
        [string]$Name,
        [int]$Age
    )

    Write-Output "Hello, my name is $Name and I am $Age years old."
}

# Calling the function
Introduce-User -Name "Bob" -Age 30

它的工作原理如下：

1. 函数定义：定义函数Introduce-User。
2. 参数定义：param 块现在包含两个参数：$Name 类型为 [string] 和 $Age 类型为 [int]。
3. 函数逻辑：Write-Output cmdlet 会打印一条包含 $Name 和 $Age 参数的消息。
4. 函数调用：使用-Name和-Age参数调用函数，并传递值“Bob”和 30 分别。

您可以在下面的屏幕截图中看到我执行上面的 PowerShell 脚本后的输出。

具有命名参数的 PowerShell 函数

在 PowerShell 中，命名参数允许您在调用函数时按名称指定参数。

这是一个完整的示例和完整的 PowerShell 脚本。

function Calculate-Sum {
    param (
        [int]$Number1,
        [int]$Number2
    )

    $Sum = $Number1 + $Number2
    Write-Output "The sum of $Number1 and $Number2 is $Sum."
}

# Calling the function with named parameters
Calculate-Sum -Number1 5 -Number2 10

读取 PowerShell 数据类型

具有位置参数的 PowerShell 函数

位置参数允许您在 PowerShell 中调用函数时省略参数名称。参数的顺序决定了它们对应的参数。

function Calculate-Sum {
    param (
        [int]$Number1,
        [int]$Number2
    )

    $Sum = $Number1 + $Number2
    Write-Output "The sum of $Number1 and $Number2 is $Sum."
}

# Calling the function with positional parameters
Calculate-Sum 5 10

带有开关参数的 PowerShell 函数

开关参数用于 PowerShell 函数中的布尔标志。它们不需要值；它们的存在本身就表明真实。

function Show-Details {
    param (
        [switch]$Verbose
    )

    if ($Verbose) {
        Write-Output "Showing detailed information..."
    } else {
        Write-Output "Showing basic information..."
    }
}

# Calling the function with the switch parameter
Show-Details -Verbose

我希望您现在知道如何使用这些示例在 PowerShell 中创建带参数的函数。