Powershell脚本参数:显示错误使用的帮助?

时间:2012-06-29 20:33:46

标签: powershell parameters

在Powershell V2中,我试图使用Param()声明来解析传递给脚本的开关。可以使用此脚本(example.ps1)说明我的问题:

Param(
    [switch] $A,
    [switch] $B,
    [switch] $C
)
echo "$A, $B, $C"

我的问题是这个脚本会默默地忽略任何不正确的开关。例如,“example.ps1 -asdf”只会打印“False,False,False”,而不是向用户报告错误的用法。

我注意到如果添加位置参数,行为会发生变化:

Param(
    [switch] $A,
    [switch] $B,
    [switch] $C,
    [parameter(position=0)] $PositionalParameter
)
echo "A:$A, B:$B, C:$C"

现在,如果我运行“example2.ps1 -asdf”,将引发ParameterBindingException。但是,“example2.ps1 asdf”(注意没有前导破折号的参数)仍然会被默默接受。

我有两个问题:

  1. 有没有办法让Powershell总是向我的脚本报告一个额外的参数作为错误?在我的脚本中,我只想允许固定的一组开关(-A,-B,-C),任何其他参数应该是一个错误。

  2. 当检测到参数错误时,我是否可以让Powershell打印用法(即“get-help example.ps1”)而不是引发ParameterBindingException?

2 个答案:

答案 0 :(得分:5)

您可以尝试使用CmdletBinding作为about_Functions_CmdletBindingAttribute中的解释,在具有CmdletBinding属性的函数中,未知参数和位置参数没有匹配的位置参数会导致参数绑定失败。

[CmdletBinding()]
Param(
      [switch] $A,
      [switch] $B,
      [switch] $C)

echo "A:$A, B:$B, C:$C"

答案 1 :(得分:2)

您可以尝试以这种方式检查$args

Function myfunction
{
  param(
        [switch] $A,
        [switch] $B,
        [switch] $C
)

foreach ( $key in $PSBoundParameters.keys )
{    
  if ( $args -gt 0) 
        {$script:test = $false ; break}
    else
        {$script:test = $true}
}    

if ($test)     
{ 
 "Parameters are ok" # ... your code script here
}    
else
{
  "Parameters error. Check Command" # or get-help myfuction
}
}