如何在 PowerShell 中强制设置参数？

Question

如何在 PowerShell 中强制设置参数？

Answer 1

您可以在每个参数上方的属性中指定它，如下所示：

function Do-Something{
    [CmdletBinding()]
    param(
        [Parameter(Position=0,mandatory=$true)]
        [string] $aMandatoryParam,
        [Parameter(Position=1,mandatory=$true)]
        [string] $anotherMandatoryParam)

    process{
       ...
    }
}

Answer 2

要使参数成为强制参数，请在参数描述中添加“Mandatory=$true”。要使参数可选，只需保留“强制”语句即可。

此代码适用于脚本和函数参数：

[CmdletBinding()]
param(
  [Parameter(Mandatory=$true)]
  [String]$aMandatoryParameter,

  [String]$nonMandatoryParameter,

  [Parameter(Mandatory=$true)]
  [String]$anotherMandatoryParameter
)

确保“param”语句是脚本或函数中的第一个语句（注释和空行除外）。

您可以使用“Get-Help”cmdlet 来验证参数是否已正确定义：

PS C:\> get-help Script.ps1 -full
[...]
PARAMETERS
    -aMandatoryParameter <String>

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?

    -NonMandatoryParameter <String>

        Required?                    false
        Position?                    2
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?

    -anotherMandatoryParameter <String>

        Required?                    true
        Position?                    3
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?

Answer 3

只是想发布另一个解决方案，因为我发现 param(...) 块有点难看。
看起来像这样的代码：

function do-something {
    param(
        [Parameter(Position=0, Mandatory=$true)]
        [string] $First,

        [Parameter(Position=1, Mandatory=$true)]
        [string] $Second
    )
    ...
}

也可以像这样写得更简洁：

function do-something (
        [Parameter(Mandatory)] [string] $First,
        [Parameter(Mandatory)] [string] $Second
    ) {
    ...
}

看起来好多了！ =$true 可以省略，因为 mandatory 是一个开关参数。

Answer 4

您不必指定 Mandatory=true，Mandatory 就足够了。

简单示例：

function New-File
{
    param(
        [Parameter(Mandatory)][string]$FileName
    )

    New-Item -ItemType File ".\$FileName"
}