about_Return

简短说明

退出当前作用域,它可以是函数、脚本或脚本块。

长说明

关键字 return 退出函数、脚本或脚本块。 它可用于在特定点退出范围、返回值或指示已达到范围末尾。

熟悉 C 或 C# 等语言的用户可能想要使用 return 关键字使离开作用域的逻辑明确。

在 PowerShell 中,即使没有包含 Return 关键字的语句,每个语句的结果也会作为输出返回。 C 或 C# 等语言仅返回关键字指定的 return 值或值。

备注

从 PowerShell 5.0 开始,PowerShell 使用正式语法添加了用于定义类的语言。 在 PowerShell 类的上下文中,除了使用 return 语句指定的方法之外,没有输出任何内容。 可以在 about_Classes 中了解有关 PowerShell 类的详细信息。

语法

关键字的 return 语法如下所示:

return [<expression>]

关键字 return 可以单独显示,也可以后跟值或表达式,如下所示:

return
return $a
return (2 + $a)

示例

以下示例使用 return 关键字在满足条件时在特定点退出函数。 奇数不相乘,因为 return 语句在该语句可以执行之前退出。

function MultiplyEven
{
    param($number)

    if ($number % 2) { return "$number is not even" }
    $number * 2
}

1..10 | ForEach-Object {MultiplyEven -Number $_}
1 is not even
4
3 is not even
8
5 is not even
12
7 is not even
16
9 is not even
20

在 PowerShell 中,即使不使用关键字,也可以返回 return 值。 返回每个语句的结果。 例如,以下语句返回变量的值 $a

$a
return

以下语句还返回值 $a

return $a

以下示例包含一个语句,旨在让用户知道函数正在执行计算:

function calculation {
    param ($value)

    "Please wait. Working on calculation..."
    $value += 73
    return $value
}

$a = calculation 14

“请等待。 正在处理计算...”不显示字符串。 而是将其 $a 分配给变量,如以下示例所示:

PS> $a
Please wait. Working on calculation...
87

函数返回信息字符串和计算结果,并分配给 $a 变量。

如果要在函数中显示一条消息,从 PowerShell 5.0 开始,可以使用 Information 流。 下面的代码更正了 Write-Information 使用 cmdlet 和 InformationActionContinue 的 cmdlet 的示例。

function calculation {
    param ($value)

    Write-Information "Please wait. Working on calculation..." -InformationAction Continue
    $value += 73
    return $value
}

$a = calculation 14
Please wait. Working on calculation...
C:\PS> $a
87

返回值和管道

从脚本块或函数返回集合时,PowerShell 会自动取消注册成员,并一次通过管道传递它们。 这是因为 PowerShell 的一次性处理。 有关详细信息,请参阅 about_pipelines

以下示例函数演示了此概念,该函数返回数字数组。 函数的输出通过管道传递给 Measure-Object cmdlet,该 cmdlet 计算管道中的对象数。

function Test-Return
{
    $array = 1,2,3
    return $array
}
Test-Return | Measure-Object
Count    : 3
Average  :
Sum      :
Maximum  :
Minimum  :
Property :

若要强制脚本块或函数将集合作为单个对象返回到管道,请使用以下两种方法之一:

  • 一元数组表达式

    利用一元表达式,可以将返回值作为单个对象发送到管道,如以下示例所示。

    function Test-Return
    {
        $array = 1,2,3
        return (, $array)
    }
    Test-Return | Measure-Object
    
    Count    : 1
    Average  :
    Sum      :
    Maximum  :
    Minimum  :
    Property :
    
  • Write-Output 具有 NoEnumerate 参数。

    还可以将 Write-Output cmdlet 与 NoEnumerate 参数配合使用。 以下示例使用 Measure-Object cmdlet 对关键字 return 从示例函数发送到管道的对象进行计数。

    function Test-Return
    {
        $array = 1, 2, 3
        return Write-Output -NoEnumerate $array
    }
    
    Test-Return | Measure-Object
    
    Count    : 1
    Average  :
    Sum      :
    Maximum  :
    Minimum  :
    Property :
    

另请参阅