PowerShell 函数参数 |工作|示例

PowerShell函数参数介绍

PowerShell函数参数通过使用属性和参数来限制用户输入某些值，从而使函数变得丰富。它添加了一些检查和验证以避免为它们编写长代码，并且它们很容易使用。声明函数参数后，也可以通过命令行传递参数。函数参数包括命名参数、位置参数、开关参数和动态参数。函数参数还有助于将简单函数转换为高级函数。

PowerShell 函数参数的语法

函数内的参数通常在 Param() 块内描述。

1.具有单个参数的命名参数语法。

function TestFunction{
param (
[Parameter()]
[TypeName]
$ParameterName
)
<Statement list>
}

在上面的例子中，我们可以添加多个参数值。有不同的命名参数属性，如 Mandatory、ValueFromPipeline、Position、ParameterSetName 等。Typename 是 ParameterName 的数据类型，如 String、Integer、Character。

2.具有高级功能的命名参数语法。

当我们添加 CmdletBinding 属性时，它将函数转换为高级函数。创建高级函数时，该函数会使用其他公共参数。

function TestFunction{
[CmdletBinding()]
param (
[Parameter()]
[TypeName]
$ParameterName
)
<Statement list>
}

3.带有属性的参数。

一个。具有单个参数的参数。

function testparam{
param(
[Parameter(Argument=Value)]
[ParameterType]
$ParameterName)
}

b.具有多个参数的参数。

function testparam{
param(
[Parameter(Argument1=Value1,
Argument2=Value2)]
[ParameterType]
$ParameterName)
}

4. 参数集语法。

function testparam{
Param(
[Parameter(AttributeValue1)]
[ParameterType]
[$ParameterName],
[Parameter(AttributeValue2)]
[ParameterType]
[$ParameterName]
)
}

函数参数在 PowerShell 中如何工作？

当我们使用函数参数时，当 PowerShell 调用该函数时，它首先检查函数中声明的参数，例如该参数是否被声明为强制参数或指定了管道中的值或指定的任何其他参数。

您还可以使用命令行传递这些参数。

示例：

代码：

function Testfunct{
param(
[Parameter (Mandatory = $false)]
[String]$Name
)
Write-Output "Name : $name"
}

您可以传递参数，如下所示。

代码：

Testfunct -Name "PowerShell"

您还可以使用该函数的帮助来了解可用参数。

输出：

PowerShell 函数参数示例

下面给出了 PowerShell 函数参数的示例：

例子#1

没有参数块的简单功能。

在下面的示例中，仅定义了 Param 块，但未定义 Parameter 块。我们只是用 String 数据类型声明了 Name 变量。

代码：

Function PrintName{
param(
[String]$Name
)
Write-Output "Hello : $name !!! "
}
PrintName -Name PowerShell

输出：

例子#2

带有强制参数的函数。

当指定强制参数为 $true 值时，调用函数时必须传递变量值；否则会产生错误。

第一个示例相当于强制参数为 false。

代码：

Function PrintName{
Param(
[Parameter(Mandatory=$false)]
[String]$Name
)
Write-Output "Hello : $name !!! "
}
PrintName

如果直接调用函数而不指定任何值，则不会给出任何错误。

输出：

如果您将强制参数指定为true，并且在不传递任何值的情况下调用该函数，那么它将询问该值，如果您没有指定那个时间，那么它将产生一个函数错误。

提供价值。

不提供强制值。

上述输出生成参数绑定异常。

例子#3

带位置参数的函数。

当我们指定带有位置参数（关键字（Position））的函数时，不需要指定参数的名称。对于位置参数来说，这不是必需的和强制的。

代码：

Function Get-ServersInfo{
Param(
[Parameter(Mandatory=$true,Position=0)]
[String[]]$ComputerName
)
Write-Output "Computers :"
$ComputerName
}
Get-ServersInfo Computer1,Computer2

输出：

在上面的示例中，函数 Get-ServersInfo 使用默认位置参数 Position=0，因此我们直接传递计算机名称。如果我们有多个位置参数，那么我们将使用每个参数名称来增加位置。

代码：

Function Get-ServersInfo{
Param(
[Parameter(Mandatory=$true,Position=1)]
[Int]$port,
[Parameter(Mandatory=$true,Position=0)]
[String[]]$ComputerName
)
Write-Output "Computers :"
$ComputerName
}
Get-ServersInfo Computer1,Computer2 8080

输出：

在上面的例子中，即使我们先声明了 port 变量，但它的位置值为 1，而 ComputerName 变量位置值为 0，所以它首先采用的是计算机名称。

例子#4

具有 ValueFromPipeline 属性的函数参数。

当 ValueFromPipeline 值设置为 true 时，我们可以使用 Pipeline 传递变量。

代码：

Function Get-ProcessInfo{
Param(
[Parameter(Mandatory=$true,
ValueFromPipeline=$true)]
[String[]]$Process
)
Get-Process -Process $Process
}
“Notepad” | Get-ProcessInfo

输出：

当我们使用Pipeline传递多个进程时，可能行不通，但是直接传值也是可以的。

使用管道传递值。

在这种情况下，我们可以使用 Begin、Process 和 End 块。

代码：

Function Get-ProcessInfo{
Param(
[Parameter(Mandatory=$true,
ValueFromPipeline=$true)]
[String[]]$Process
)
Begin{}
Process{Get-Process $Process}
end{}
}
“Notepad”,”Winword” | Get-ProcessInfo

输出：

例子#5

带有开关属性的函数参数。

与 Switch 函数一样，我们可以在函数内部使用 switch 参数。在下面的示例中，如果我们将重新启动开关值设置为 true，则 true 块将被执行；否则，将执行 false 块。

代码：

Function Check-Switch{
param(
[Parameter(Mandatory=$false,Position=0)]
[Switch]$Reboot
)
if($Reboot){"Server Reboot requested"}
else{"Server will not reboot"}
}
Check-Switch $true
Check-Switch $false

输出：

例子#6

带有帮助消息的函数参数。

当您需要显示参数的描述或需要放置与该参数相关的任何帮助命令时，您可以使用 HelpMessage 功能。要显示该消息，您需要使用 Get-Help 命令。

代码：

Function Check-HelpMsg{
param(
[Parameter(Mandatory=$true,HelpMessage="Enter the Name of the processes separated by comma")]
[String[]]$Process
)
Begin{}
Process{Get-Process $Process}
End{}
}
help Check-HelpMsg -Full

输出：

例子#7

具有验证集属性的函数参数。

我们可以直接在带有验证集的参数块内提供验证，而不是在脚本内编写长验证。

代码：

Function Validate{
param(
[Parameter(Mandatory=$true)]
[ValidateSet("Cat","Dog","Cow","Tiger")]
[String[]]$Animals,
[Parameter(Mandatory=$true)]
[ValidateRange(10,20)]
[Int]$Age
)
Write-Output "Animals:"
$Animals
Write-Output "Age: $Age"
}
validate -Animals
validate -Animals Dog,Cow -Age 15

输出：

当您键入验证集中定义的参数名称时，它会弹出值。这适用于 ISE，但可能不会出现在不同的控制台中。在这种情况下，我们就可以使用。

验证范围内的值。

超出验证范围的值会引发异常。

结论

正如我们在上面的示例中所看到的，PowerShell 函数参数非常有用。它通过在函数开头指定它们来降低代码复杂性，并且我们不需要编写额外的代码来验证数据。我们可以使用异常处理机制来处理异常。