如何在PowerShell中为脚本提供param属性?

时间:2012-09-14 11:56:57

标签: powershell parameters

我有这个可以通过两种方式调用的脚本:

MyScript -foo path\to\folder

MyScript -bar path\to\folder

(也就是说,我可以传递开关加上文件夹或字符串参数以及文件夹。)

我试图将parameter declarations放入我的脚本中以反映该语法:

param(
  [parameter(Mandatory=$false)] [switch]$foo,
  [parameter(Mandatory=$false)] [String]$bar,
  [parameter(Mandatory=$true)]  [System.IO.FileInfo]$path
)

但是我必须明确地传递path来调用脚本:

MyScript -l -path path\to\folder

那么(如何)我可以同时制作barpath位置参数?

注意:如果我选择了一个非常愚蠢的语法来调用脚本,我仍然可以更改它。

2 个答案:

答案 0 :(得分:26)

以下几点:您需要使用参数集来告诉PowerShell有相互排斥的方式来调用您的脚本;也就是说,你不能同时使用开关和字符串。这些集合还允许您将$bar$filepath的位置设置为索引0.开关不需要按位置放置,因为它们对于活页夹没有模糊并且被放置任何地方。此外,每组中至少应有一个参数是强制性的。

function test-set {
    [CmdletBinding(DefaultParameterSetName = "BarSet")]
    param(
        [parameter(
            mandatory=$true,
            parametersetname="FooSet"
        )]
        [switch]$Foo,

        [parameter(
            mandatory=$true,
            position=0,
            parametersetname="BarSet"
        )]
        [string]$Bar,

        [parameter(
            mandatory=$true,
            position=1
        )]
        [io.fileinfo]$FilePath
    )
@"
  Parameterset is: {0}
  Bar is: '{1}'
  -Foo present: {2}
  FilePath: {3}
"@ -f $PSCmdlet.ParameterSetName, $bar, $foo.IsPresent, $FilePath
}

如果在没有参数的情况下调用函数,则需要CmdletBinding属性来指定哪个参数集应该是默认值。

以下是上述配置的语法帮助:

PS> test-set -?

NAME
    test-set

SYNTAX
    test-set [-Bar] <string> [-FilePath] <FileInfo>  [<CommonParameters>]

    test-set [-FilePath] <FileInfo> -Foo  [<CommonParameters>]

这是各种调用的输出:

PS> test-set barval C:\temp\foo.zip
  Parameterset is: BarSet
  Bar is: 'barval'
  -Foo present: False
  FilePath: C:\temp\foo.zip

PS> test-set -foo c:\temp\foo.zip
  Parameterset is: FooSet
  Bar is: ''
  -Foo present: True
  FilePath: c:\temp\foo.zip

希望这有帮助。

答案 1 :(得分:0)

如[{3}}所述,您可以指定参数的参数位置。

[parameter(Position=0)]