PowerShell 函数：返回值和多个值

本教程介绍如何使用返回单个值和多个值的 PowerShell 函数。我将提供示例并向您展示如何从 PowerShell 函数返回多个值。

PowerShell 函数示例返回值

如果您不熟悉 PowerShell 中的函数，那么这里是声明函数的语法。

function Get-Greeting {
    param (
        [string]$Name
    )
    "Hello, $Name!"
}

在此示例中，函数 Get-Greeting 采用单个参数 $Name 并返回问候语字符串。

从 PowerShell 函数返回单个值

在 PowerShell 中，您可以通过使用 return 关键字或简单地输出值来从函数返回值。操作方法如下：

function Get-Square {
    param (
        [int]$Number
    )
    return $Number * $Number
}

# Usage
$result = Get-Square -Number 5
Write-Output $result

在此示例中，函数 Get-Square 计算输入数字的平方并使用 return 关键字返回它。

使用 VS code 执行上面的脚本后，您可以在下面的屏幕截图中看到输出。

或者，您可以直接输出值，而不使用 return：

function Get-Square {
    param (
        [int]$Number
    )
    $Number * $Number
}

# Usage
$result = Get-Square -Number 5
Write-Output $result  # Output: 25

两种方法都是有效的，但使用 return 关键字可以更清楚地表明该函数旨在返回一个值。

阅读带参数的 PowerShell 函数示例

从函数返回多个值

使用各种方法，您还可以从 PowerShell 中的函数返回多个值。

使用数组

从 PowerShell 函数返回多个值的一种方法是使用数组。这是一个例子：

function Get-Coordinates {
    param (
        [int]$X,
        [int]$Y
    )
    return @($X, $Y)
}

# Usage
$coords = Get-Coordinates -X 10 -Y 20
Write-Output "X: $($coords[0]), Y: $($coords[1])"

在此示例中，函数 Get-Cooperatives 返回一个包含 X 和 Y 坐标的数组。

您可以在下面的屏幕截图中看到输出：

使用哈希表

您还可以使用哈希表从数组返回多个值，这允许您返回命名值。这是一个例子：

function Get-UserInfo {
    param (
        [string]$Name,
        [int]$Age
    )
    return @{
        Name = $Name
        Age  = $Age
    }
}

# Usage
$userInfo = Get-UserInfo -Name "Alice" -Age 30
Write-Output "Name: $($userInfo.Name), Age: $($userInfo.Age)"  # Output: Name: Alice, Age: 30

这里，函数 Get-UserInfo 返回一个包含用户姓名和年龄的哈希表。

使用自定义对象

从 PowerShell 函数中，您还可以使用自定义对象返回多个值。这是一个例子：

function Get-Employee {
    param (
        [string]$Name,
        [string]$Title
    )
    $employee = [PSCustomObject]@{
        Name  = $Name
        Title = $Title
    }
    return $employee
}

# Usage
$employee = Get-Employee -Name "John Doe" -Title "Manager"
Write-Output "Name: $($employee.Name), Title: $($employee.Title)"  # Output: Name: John Doe, Title: Manager

在此示例中，Get-Employee 返回一个具有属性 Name 和 Title 的自定义对象。

阅读 PowerShell 中的 Try-Catch

PowerShell 函数：使用参数和返回值

在本节中，我将展示一些带有参数和返回值的 PowerShell 函数示例。

就像，我现在将向您展示如何定义带有参数和返回值的函数。

带参数的 PowerShell 函数

要在 PowerShell 中定义带参数的函数，请使用 param 块。这是一个简单的例子：

function Get-Greeting {
    param (
        [string]$Name
    )
    "Hello, $Name!"
}

# Usage
$greeting = Get-Greeting -Name "Alice"
Write-Output $greeting  # Output: Hello, Alice!

在此示例中，函数 Get-Greeting 采用单个参数 $Name 并返回问候语字符串。

返回单个值

您可以使用 return 关键字或简单地输出值来从函数返回值。这是一个例子：

function Get-Square {
    param (
        [int]$Number
    )
    return $Number * $Number
}

# Usage
$result = Get-Square -Number 5
Write-Output $result  # Output: 25

在此示例中，函数 Get-Square 计算输入数字的平方并使用 return 关键字返回它。

或者，您可以直接输出值，而不使用 return：

function Get-Square {
    param (
        [int]$Number
    )
    $Number * $Number
}

# Usage
$result = Get-Square -Number 5
Write-Output $result  # Output: 25

这两种方法都是有效的，但使用 return 可以更清楚地表明该函数旨在返回一个值。

使用多个参数

您可以在 PowerShell 函数中定义具有多个参数的函数。这是一个例子：

function Add-Numbers {
    param (
        [int]$FirstNumber,
        [int]$SecondNumber
    )
    return $FirstNumber + $SecondNumber
}

# Usage
$sum = Add-Numbers -FirstNumber 10 -SecondNumber 20
Write-Output $sum 

在此示例中，函数 Add-Numbers 接受两个参数，将它们相加，然后返回结果。

带参数并返回多个值的 PowerShell 函数

以下是带参数的 PowerShell 函数的一些示例，该函数返回多个值

使用数组

以下是带有参数并使用数组返回多个值的 PowerShell 函数的示例：

function Get-Coordinates {
    param (
        [int]$X,
        [int]$Y
    )
    return @($X, $Y)
}

# Usage
$coords = Get-Coordinates -X 10 -Y 20
Write-Output "X: $($coords[0]), Y: $($coords[1])"  # Output: X: 10, Y: 20

在此示例中，函数 Get-Cooperatives 返回一个包含 X 和 Y 坐标的数组。

使用哈希表

以下是带有参数的 PowerShell 函数示例，该函数使用哈希表返回多个值。

function Get-UserInfo {
    param (
        [string]$Name,
        [int]$Age
    )
    return @{
        Name = $Name
        Age  = $Age
    }
}

# Usage
$userInfo = Get-UserInfo -Name "Alice" -Age 30
Write-Output "Name: $($userInfo.Name), Age: $($userInfo.Age)"

这里，函数 Get-UserInfo 返回一个包含用户姓名和年龄的哈希表。

您可以在下面的屏幕截图中看到输出：

使用自定义对象

以下是带有参数的 PowerShell 函数示例，该函数使用自定义对象返回多个值。

function Get-Employee {
    param (
        [string]$Name,
        [string]$Title
    )
    $employee = [PSCustomObject]@{
        Name  = $Name
        Title = $Title
    }
    return $employee
}

# Usage
$employee = Get-Employee -Name "John Doe" -Title "Manager"
Write-Output "Name: $($employee.Name), Title: $($employee.Title)"  # Output: Name: John Doe, Title: Manager

在此示例中，Get-Employee 返回一个具有属性 Name 和 Title 的自定义对象。

结论

在本 PowerShell 教程中，我解释了带有返回值的 PowerShell 函数，并展示了一些接受参数并返回单个和多个值的 PowerShell 函数示例。

您可以使用数组、哈希表或复杂对象从 PowerShell 函数返回多个值。

如果您仍有疑问，请随时在下面发表评论。