Guide pratique pour déclarer des paramètres d’applet de commande

Ces exemples montrent comment déclarer des paramètres nommés, positionnels, obligatoires, facultatifs et de commutateur. Ces exemples montrent également comment définir un alias de paramètre.

Comment déclarer un paramètre nommé

• Définissez une propriété publique comme indiqué dans le code suivant. Lorsque vous ajoutez l’attribut de paramètre, omettez le Position mot clé de l’attribut.

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

Pour plus d’informations sur l’attribut de paramètre, consultez déclaration d’attribut de paramètre.

Comment déclarer un paramètre positionnel

• Définissez une propriété publique comme indiqué dans le code suivant. Lorsque vous ajoutez l’attribut de paramètre, définissez le Position mot clé sur la position de l’argument. La valeur 0 indique la première position.

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

Pour plus d’informations sur l’attribut de paramètre, consultez déclaration d’attribut de paramètre.

Comment déclarer un paramètre obligatoire

• Définissez une propriété publique comme indiqué dans le code suivant. Lorsque vous ajoutez l’attribut de paramètre, affectez au Mandatory mot clé la valeur true .

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

Pour plus d’informations sur l’attribut de paramètre, consultez déclaration d’attribut de paramètre.

Comment déclarer un paramètre facultatif

• Définissez une propriété publique comme indiqué dans le code suivant. Lorsque vous ajoutez l’attribut de paramètre, omettez le Mandatory mot clé.

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

Comment déclarer un paramètre de commutateur

• Définissez une propriété publique en tant que type System. Management. Automation. Paramètre_Booléen, puis déclarez l’attribut du paramètre.

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

Pour plus d’informations sur l’attribut de paramètre, consultez déclaration d’attribut de paramètre.

Comment déclarer un paramètre avec des alias

• Définissez une propriété publique comme indiqué dans le code suivant. Ajoutez un attribut alias qui répertorie les alias pour le paramètre. Dans cet exemple, trois alias sont définis pour le même paramètre. Le premier alias fournit un raccourci. Le deuxième et le troisième alias fournissent des noms que vous pouvez utiliser pour différents scénarios.

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

Pour plus d’informations sur l’attribut alias, consultez déclaration d’attribut d’alias.

Voir aussi

System.Management.Automation.SwitchParameter

Déclaration de l’attribut Parameter

Déclaration de l’attribut Alias

Écriture d’une applet de commande Windows PowerShell