如何声明 Cmdlet 参数

这些示例演示如何声明命名、位置、必需、可选和 [switch] 参数。这些示例还演示如何定义参数别名。

如何声明命名参数

定义公共属性，如以下代码所示。添加 Parameter 属性时，请省略 Position 属性中的关键字。

[Parameter()]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

有关参数属性的详细信息，请参阅参数属性声明。

如何声明位置参数

定义公共属性，如以下代码所示。添加 Parameter 属性时，请将 Position 关键字设置为参数位置。值为 0 表示第一个位置。
```
[Parameter(Position = 0)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;
```

有关参数属性的详细信息，请参阅参数属性声明。

如何声明必需参数

定义公共属性，如以下代码所示。添加 Parameter 属性时，请将 Mandatory 关键字设置为 true.

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

有关参数属性的详细信息，请参阅参数属性声明。

如何声明可选参数

定义公共属性，如以下代码所示。添加 Parameter 属性时，省略 Mandatory 关键字。

[Parameter(Position = 0)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

如何声明 `[switch]` 参数

将公共属性定义为 System.Management.Automation.SwitchParameter 类型，然后声明 Parameter 属性。

[Parameter(Position = 1)]
public SwitchParameter GoodBye
{
  get { return goodbye; }
  set { goodbye = value; }
}
private bool goodbye;

有关参数属性的详细信息，请参阅参数属性声明。

如何使用别名声明参数

定义公共属性，如以下代码所示。添加列出参数别名的 Alias 属性。在此示例中，为同一参数定义了三个别名。第一个别名提供快捷方式。第二个和第三个别名提供可用于不同方案的名称。
```
[Alias("UN","Writer","Editor")]
[Parameter()]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;
```

有关别名属性的详细信息，请参阅别名属性声明。