问题描述
请注意,示例代码是人为设计的,仅用于说明问题。
我想在 powershell 中创建一个函数来获取一些随机数,但我遇到了一个非常奇怪的问题,当我不使用参数的位置定义时,我仍然会收到一个错误。
我的代码是:
function select-random {
param(
[Parameter(Position = 0,Mandatory)]
[int]$min,[Parameter(Position = 1,Mandatory)]
[int]$max
)
Get-Random $min $max
}
此脚本使用以下命令出现的错误:select-random 5 10
A positional parameter cannot be found that accepts argument '10'.
并使用命令:select-random -min 5 -max 10
A positional parameter cannot be found that accepts argument '10'.`
最奇怪的是 ISE 检测到选项卡菜单中手动定义的参数。
是我的语法错误还是 powershell 错误,但主要是我如何解决这个问题?
解决方法
Theo 和 JosefZ 在问题的评论中提供了关键的提示:
您试图将 $min
和 $max
参数位置传递给 Get-Random
,但 Get-Random
仅支持 一个位置参数,即-Maximum
参数。
因此,至少必须将 $min
值作为 named 参数传递,即作为 -Minimum $min
传递,以便您的命令在语法上工作。但是,为了对称性和可读性,最好也将 $max
作为命名参数传递:
# Use *named* arguments.
Get-Random -Minimum $min -Maximum $max
如何确定命令的位置参数:
about_Command_Syntax 概念性帮助主题描述了 PowerShell 所谓的语法图中使用的符号。
要显示语法图(仅),请使用 Get-Command -Syntax
(或传递 -?
/ 使用 Get-Help
,显示附加信息):
PS> & { Get-Command -Syntax $args[0] } Get-Random
Get-Random [[-Maximum] <Object>] [-SetSeed <int>] [-Minimum <Object>] [-Count <int>] [<CommonParameters>]
Get-Random [-InputObject] <Object[]> -Shuffle [-SetSeed <int>] [<CommonParameters>]
Get-Random [-InputObject] <Object[]> [-SetSeed <int>] [-Count <int>] [<CommonParameters>]
只有单独名称包含在[...]
[1]中的参数才是位置 - 例如[-Maximum]
- 并且,如果支持多个,则按照调用时必须传递的顺序列出。
请注意,每个输出行代表一个单独的参数集(请参阅 about_Parameter_Sets),但由于您传递的是最小值和最大值,因此此处仅对第一个感兴趣:
如您所见,在第一个参数集中只有 -Maximum
是位置性的,而 -Minimum
和所有其他参数都不是。
这是辅助函数Get-PositionalParameter
,它可以更轻松地确定命令的位置参数:
Function Get-PositionalParameter {
<#
.SYNOPSIS
Outputs a given command's positional parameters,if any.
#>
param(
[Parameter(Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName)]
[string] $Name
)
Set-StrictMode -Version 1; $ErrorActionPreference = 'Stop'
# Resolve the name to a cmdlet first,if necessary
$cmd = (Get-Command $Name)
if ($cmd.ResolvedCommand) { $cmd = $cmd.ResolvedCommand }
$cmd.ParameterSets | ForEach-Object {
if ($posParams = $_.Parameters.Where( { $_.Position -ge 0 })) {
[pscustomobject] @{
PositionalParams = $posParams.Name
ParameterSet = $_.Name
}
}
}
}
应用于Get-Random
:
PS> Get-PositionalParameter Get-Random
PositionalParams ParameterSet
---------------- ------------
Maximum RandomNumberParameterSet
InputObject ShuffleParameterSet
InputObject RandomListItemParameterSet
请注意,参数集 names 不会出现在帮助主题中以及使用 Get-Command -Syntax
时,因为它们实际上并不用于公开显示,但它们的名称通常足以说明其用途。
[1] 将此与包含在 [...]
中的参数规范整体形成对比 - 例如[-Minimum <Object>]
- 它独立地表明参数作为一个整体是可选(不是强制性的,即传递一个参数不是必需)。 >