about_Script_Blocks

简短说明

定义什么是脚本块,并说明如何使用 PowerShell 编程语言中的脚本块。

长说明

在 PowerShell 编程语言中,脚本块是可用作单个单元的语句或表达式的集合。 脚本块可以接受参数并返回值。

从语法上讲,脚本块是大括号中的语句列表,如以下语法所示:

{<statement list>}

脚本块以单个对象或数组的形式返回脚本块中所有命令的输出。

还可以使用 return 关键字 (keyword) 指定返回值。 关键字 (keyword) return 不会影响或禁止从脚本块返回的其他输出。 但是,return关键字 (keyword) 退出该行处的脚本块。 有关详细信息,请参阅 about_Return

与函数一样,脚本块可以包含参数。 使用 Param 关键字 (keyword) 分配命名参数,如以下语法所示:

{
Param([type]$Parameter1 [,[type]$Parameter2])
<statement list>
}

注意

在脚本块中,与函数不同,不能在大括号外指定参数。

与函数一样,脚本块可以包含 DynamicParamBeginProcessEnd 关键字。 有关详细信息,请参阅 about_Functionsabout_Functions_Advanced

使用脚本块

脚本块是 Microsoft .NET Framework类型的System.Management.Automation.ScriptBlock实例。 命令可以具有脚本块参数值。 例如, Invoke-Command cmdlet 具有一个 ScriptBlock 参数,该参数采用脚本块值,如以下示例所示:

Invoke-Command -ScriptBlock { Get-Process }
Handles  NPM(K)    PM(K)     WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----     ----- -----   ------     -- -----------
999          28    39100     45020   262    15.88   1844 communicator
721          28    32696     36536   222    20.84   4028 explorer
...

Invoke-Command 还可以执行具有参数块的脚本块。 参数是使用 ArgumentList 参数按位置分配的。

Invoke-Command -ScriptBlock { param($p1, $p2)
"p1: $p1"
"p2: $p2"
} -ArgumentList "First", "Second"
p1: First
p2: Second

前面示例中的脚本块使用 param 关键字 (keyword) 创建参数 $p1$p2。 字符串“First”绑定到第一个参数 ($p1) ,“Second”绑定到 ($p2) 。

有关 ArgumentList 行为的详细信息,请参阅 about_Splatting

可以使用变量来存储和执行脚本块。 下面的示例将脚本块存储在变量中,并将其传递给 Invoke-Command

$a = { Get-Service BITS }
Invoke-Command -ScriptBlock $a
Status   Name               DisplayName
------   ----               -----------
Running  BITS               Background Intelligent Transfer Ser...

调用运算符是执行存储在变量中的脚本块的另一种方法。 与 一样 Invoke-Command,调用运算符在子作用域中执行脚本块。 调用运算符可以让你更轻松地将参数与脚本块一起使用。

$a ={ param($p1, $p2)
"p1: $p1"
"p2: $p2"
}
&$a -p2 "First" -p1 "Second"
p1: Second
p2: First

可以使用赋值将脚本块的输出存储在变量中。

PS>  $a = { 1 + 1}
PS>  $b = &$a
PS>  $b
2
PS>  $a = { 1 + 1}
PS>  $b = Invoke-Command $a
PS>  $b
2

有关呼叫操作员的详细信息,请参阅 about_Operators

将延迟绑定脚本块与参数配合使用

接受管道输入 (by Value) 或 (by PropertyName) 的类型化参数允许对参数使用 延迟绑定 脚本块。 在 延迟绑定 脚本块中,可以使用管道变量 $_在 对象中引用通过管道传递的 。

# Renames config.log to old_config.log
dir config.log | Rename-Item -NewName {"old_" + $_.Name}

在更复杂的 cmdlet 中,延迟绑定脚本块允许重用对象中的一个管道来填充其他参数。

有关 延迟绑定 脚本块作为参数的说明:

  • 必须显式指定用于 延迟绑定 脚本块的任何参数名称。

  • 参数不得为非类型化,并且参数的类型不能为 [scriptblock][object]

  • 如果使用 延迟绑定 脚本块而不提供管道输入,则会收到错误。

    Rename-Item -NewName {$_.Name + ".old"}
    
    Rename-Item : Cannot evaluate parameter 'NewName' because its argument is
    specified as a script block and there is no input. A script block cannot
    be evaluated without input.
    At line:1 char:23
    +  Rename-Item -NewName {$_.Name + ".old"}
    +                       ~~~~~~~~~~~~~~~~~~
        + CategoryInfo          : MetadataError: (:) [Rename-Item],
          ParameterBindingException
        + FullyQualifiedErrorId : ScriptBlockArgumentNoInput,
          Microsoft.PowerShell.Commands.RenameItemCommand
    

另请参阅