Deklarieren von Cmdlet-Parametern

In diesen Beispielen wird gezeigt, wie benannte, positionale, erforderliche, optionale und [switch] Parameter deklariert werden. In diesen Beispielen wird auch gezeigt, wie Sie einen Parameteralias definieren.

So deklarieren Sie einen benannten Parameter

• Definieren Sie eine öffentliche Eigenschaft wie im folgenden Code dargestellt. Wenn Sie das Parameter-Attribut hinzufügen, lassen Sie das Position Schlüsselwort aus dem Attribut aus.

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

Weitere Informationen zum Parameter-Attribut finden Sie unter Parameter-Attributdeklaration.

So deklarieren Sie einen Positionsparameter

• Definieren Sie eine öffentliche Eigenschaft wie im folgenden Code dargestellt. Wenn Sie das Parameter-Attribut hinzufügen, legen Sie das Position Schlüsselwort auf die Argumentposition fest. Ein Wert von 0 gibt die erste Position an.

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

Weitere Informationen zum Parameter-Attribut finden Sie unter Parameter-Attributdeklaration.

So deklarieren Sie einen obligatorischen Parameter

• Definieren Sie eine öffentliche Eigenschaft wie im folgenden Code dargestellt. Wenn Sie das Parameter-Attribut hinzufügen, legen Sie das Mandatory Schlüsselwort auf true.

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

Weitere Informationen zum Parameter-Attribut finden Sie unter Parameter-Attributdeklaration.

So deklarieren Sie einen optionalen Parameter

• Definieren Sie eine öffentliche Eigenschaft wie im folgenden Code dargestellt. Wenn Sie das Parameter-Attribut hinzufügen, müssen Sie das Mandatory Schlüsselwort weglassen.

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

So deklarieren Sie einen [switch] Parameter

• Definieren Sie eine öffentliche Eigenschaft als Typ "System.Management.Automation.SwitchParameter", und deklarieren Sie dann das Parameter-Attribut.

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

Weitere Informationen zum Parameter-Attribut finden Sie unter Parameter-Attributdeklaration.

So deklarieren Sie einen Parameter mit Aliasen

• Definieren Sie eine öffentliche Eigenschaft wie im folgenden Code dargestellt. Fügen Sie ein Alias-Attribut hinzu, das die Aliase für den Parameter auflistet. In diesem Beispiel werden drei Aliase für denselben Parameter definiert. Der erste Alias stellt eine Verknüpfung bereit. Die zweiten und dritten Aliase enthalten Namen, die Sie für verschiedene Szenarien verwenden können.

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

Weitere Informationen zum Alias-Attribut finden Sie unter Alias-Attributdeklaration.

Siehe auch

System.Management.Automation.SwitchParameter

Parameter-Attributdeklaration

Alias-Attributdeklaration

Schreiben eines Windows PowerShell-Cmdlets