Déclaration de l’attribut Parameter

L’attribut de paramètre identifie une propriété publique de la classe d’applet de commande en tant que paramètre d’applet de commande.

Syntaxe

[Parameter()]
[Parameter(Named Parameters...)]

Paramètres

Mandatory (System. Boolean) paramètre nommé facultatif. True indique que le paramètre d’applet de commande est requis. si un paramètre obligatoire n’est pas fourni lors de l’appel de l’applet de commande, Windows PowerShell invite l’utilisateur à entrer une valeur de paramètre. Par défaut, il s’agit de false.

ParameterSetName (System. String) paramètre nommé facultatif. Spécifie le jeu de paramètres auquel appartient ce paramètre d’applet de commande. Si aucun jeu de paramètres n’est spécifié, le paramètre appartient à tous les jeux de paramètres.

Position (System. Int32) paramètre nommé facultatif. spécifie la position du paramètre dans une commande Windows PowerShell.

ValueFromPipeline (System. Boolean) paramètre nommé facultatif. True indique que le paramètre d’applet de commande prend sa valeur d’un objet Pipeline. Spécifiez ce mot clé si l’applet de commande accède à l’objet complet, et pas simplement à une propriété de l’objet. Par défaut, il s’agit de false.

ValueFromPipelineByPropertyName (System. Boolean) paramètre nommé facultatif. True indique que le paramètre d’applet de commande prend sa valeur d’une propriété d’un objet de pipeline qui a le même nom ou le même alias que ce paramètre. Par exemple, si l’applet de commande a un Name paramètre et que l’objet de pipeline a également une Name propriété, la valeur de la Name propriété est assignée au Name paramètre de l’applet de commande. Par défaut, il s’agit de false.

ValueFromRemainingArguments (System. Boolean) paramètre nommé facultatif. True indique que le paramètre d’applet de commande accepte tous les arguments restants qui sont passés à l’applet de commande. Par défaut, il s’agit de false.

HelpMessage Paramètre nommé facultatif. Spécifie une brève description du paramètre. Windows PowerShell affiche ce message lorsqu’une applet de commande est exécutée et qu’un paramètre obligatoire n’est pas spécifié.

HelpMessageBaseName Paramètre nommé facultatif. Spécifie l’emplacement où résident les identificateurs de ressource. Par exemple, ce paramètre peut spécifier un assembly de ressource qui contient les messages d’aide que vous souhaitez localiser.

HelpMessageResourceId Paramètre nommé facultatif. Spécifie l’identificateur de ressource pour un message d’aide.

Remarques

  • Pour plus d’informations sur la façon de déclarer cet attribut, consultez comment déclarer des paramètres d’applet decommande.

  • Une applet de commande peut avoir n’importe quel nombre de paramètres. Toutefois, pour une meilleure expérience utilisateur, limitez le nombre de paramètres.

  • Les paramètres doivent être déclarés sur des propriétés ou des champs non statiques publics. Les paramètres doivent être déclarés sur les propriétés. La propriété doit avoir un accesseur Set public et, si ValueFromPipeline le ValueFromPipelineByPropertyName mot clé ou est spécifié, la propriété doit avoir un accesseur get public.

  • Lorsque vous spécifiez des paramètres positionnels, limitez le nombre de paramètres positionnels dans un paramètre défini à une valeur inférieure à 5. Les paramètres positionnels ne doivent pas nécessairement être contigus. Les positions 5, 100 et 250 fonctionnent de la même façon que les positions 0, 1 et 2.

  • Lorsque le Position mot clé n’est pas spécifié, le paramètre de l’applet de commande doit être référencé par son nom.

  • Lorsque vous utilisez des jeux de paramètres, notez les points suivants :

    • Chaque jeu de paramètres doit avoir au moins un paramètre unique. Une bonne conception d’applet de commande indique que ce paramètre unique doit également être obligatoire si possible. Si votre applet de commande est conçue pour être exécutée sans paramètres, le paramètre unique ne peut pas être obligatoire.

    • Aucun jeu de paramètres ne doit contenir plus d’un paramètre positionnel avec la même position.

    • Un seul paramètre dans un jeu de paramètres doit être déclaré ValueFromPipeline = true .

    • Plusieurs paramètres peuvent être définis ValueFromPipelineByPropertyName = true .

  • Pour plus d’informations sur les instructions relatives aux noms de paramètres, consultez noms des paramètresde l’applet de commande.

  • L’attribut Parameter est défini par la classe System. Management. Automation. ParameterAttribute .

Voir aussi

System. Management. Automation. ParameterAttribute

Noms des paramètres de l’applet de commande

Écriture d’une applet de commande Windows PowerShell