Deklarieren von Cmdlet-Parametern

In diesen Beispielen wird gezeigt, wie benannte, positionsale, erforderliche, optionale und switch-Parameter deklariert werden. In diesen Beispielen wird auch gezeigt, wie ein Parameteralias definiert wird.

Deklarieren eines benannten Parameters

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

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

Weitere Informationen zum Parameterattribut finden Sie unter Parameter Attribute Declaration.

Deklarieren eines Positionsparameters

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

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

Weitere Informationen zum Parameterattribut finden Sie unter Parameter Attribute Declaration.

Deklarieren eines obligatorischen Parameters

• Definieren Sie eine öffentliche Eigenschaft, wie im folgenden Code gezeigt. Wenn Sie das Parameterattribut hinzufügen, legen Sie das Mandatory Schlüsselwort auf true fest.

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

Weitere Informationen zum Parameterattribut finden Sie unter Parameter Attribute Declaration.

Deklarieren eines optionalen Parameters

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

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

Deklarieren eines Switch-Parameters

• Definieren Sie eine öffentliche Eigenschaft als Typ System.Management.Automation.SwitchParameter,und deklarieren Sie dann das Parameterattribut.

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

Weitere Informationen zum Parameterattribut finden Sie unter Parameter Attribute Declaration.

Deklarieren eines Parameters mit Aliasen

• Definieren Sie eine öffentliche Eigenschaft, wie im folgenden Code gezeigt. Fügen Sie ein Aliasattribut hinzu, das die Aliase für den Parameter auflistet. In diesem Beispiel werden drei Aliase für denselben Parameter definiert. Der erste Alias bietet eine Verknüpfung. Der zweite und dritte Alias stellen Namen zur Verfügung, 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 Aliasattribut finden Sie unter AliasAttributdeklaration.

Weitere Informationen

System.Management.Automation.SwitchParameter

Attributdeklaration: Parameter

Attributdeklaration: Alias

Schreiben eines Windows PowerShell-Cmdlets