通过

将属性声明为参数

  • 项目

本主题提供在声明 cmdlet 的参数之前必须了解的基本信息。

若要在 cmdlet 类中声明 cmdlet 的参数，请定义表示每个参数的公共属性，然后将一个或多个 Parameter 属性添加到每个属性。 该Windows PowerShell运行时使用 Parameter 属性将属性标识为 cmdlet 参数。 声明 Parameter 属性的基本语法为 [Parameter()] 。

下面是定义为必需参数的属性示例。

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

以下是有关参数的一些需要记住的一些内容。

  • 参数必须显式标记为 public。 未标记为内部的默认公共参数，并且运行时Windows PowerShell参数。

  • 参数应定义为 Microsoft .NET Framework类型，以提供更好的参数验证。 例如，限制为一组值中的一个值的参数应定义为枚举类型。 使用统一资源标识符 (URI) 参数的类型应为 System.Uri。

  • 对于自由格式文本属性，请避免使用基本字符串参数。

  • 可以将参数添加到任意数目的参数集。 有关参数集详细信息，请参阅 Cmdlet 参数集。

Windows PowerShell还提供了一组自动可用于每个 cmdlet 的常用参数。 有关这些参数及其别名的信息，请参阅 Cmdlet 通用参数。

另请参阅

Cmdlet 通用参数

Cmdlet 参数的类型

编写 Windows PowerShell Cmdlet