Jak zadeklarować parametry polecenia cmdlet

W tych przykładach pokazano, jak zadeklarować parametry nazwane, pozycyjne, wymagane, opcjonalne i [switch] . W tych przykładach pokazano również, jak zdefiniować alias parametru.

Jak zadeklarować nazwany parametr

• Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parametr pomiń Position słowo kluczowe z atrybutu .

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

Aby uzyskać więcej informacji na temat atrybutu Parametr, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować parametr pozycyjny

• Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parametr ustaw Position słowo kluczowe na pozycję argumentu. Wartość 0 wskazuje pierwszą pozycję.

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

Aby uzyskać więcej informacji na temat atrybutu Parametr, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować obowiązkowy parametr

• Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parametr ustaw Mandatory słowo kluczowe na true.

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

Aby uzyskać więcej informacji na temat atrybutu Parametr, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować opcjonalny parametr

• Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Po dodaniu atrybutu Parametr pomiń Mandatory słowo kluczowe.

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

Jak zadeklarować [switch] parametr

• Zdefiniuj właściwość publiczną jako typ System.Management.Automation.SwitchParameter, a następnie zadeklaruj atrybut Parametr.

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

Aby uzyskać więcej informacji na temat atrybutu Parametr, zobacz Deklaracja atrybutu parametru.

Jak zadeklarować parametr za pomocą aliasów

• Zdefiniuj właściwość publiczną, jak pokazano w poniższym kodzie. Dodaj atrybut aliasu, który wyświetla aliasy parametru. W tym przykładzie dla tego samego parametru zdefiniowano trzy aliasy. Pierwszy alias zawiera skrót. Drugie i trzecie aliasy zawierają nazwy, których można użyć w różnych scenariuszach.

  [Alias("UN","Writer","Editor")]
  [Parameter()]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Aby uzyskać więcej informacji o atrybucie Alias, zobacz Alias Attribute Declaration (Deklaracja atrybutu aliasu).

Zobacz też

System.Management.Automation.SwitchParameter

Deklaracja atrybutu parametru

Deklaracja atrybutu aliasu

Writing a Windows PowerShell Cmdlet