Partager via

Déclaration d’attribut de paramètre

L’attribut Parameter 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 (paramètre nommé System.Boolean) Facultatif. True indique que le paramètre d’applet de commande est requis. Si un paramètre obligatoire n’est pas fourni lorsque l’applet de commande est appelée, Windows PowerShell invite l’utilisateur à entrer une valeur de paramètre. La valeur par défaut est 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 (paramètre nommé System.Boolean) Facultatif. True indique que le paramètre d’applet de commande prend sa valeur à partir d’un objet de pipeline. Spécifiez ce mot clé si l’applet de commande accède à l’objet complet, pas seulement une propriété de l’objet. La valeur par défaut est false.

ValueFromPipelineByPropertyName (paramètre nommé System.Boolean) Facultatif. True indique que le paramètre d’applet de commande prend sa valeur à partir d’une propriété d’un objet de pipeline portant le même nom ou le même alias que ce paramètre. Par exemple, si l’applet de commande a un paramètre Name et que l’objet de pipeline a également une propriété Name, la valeur de la propriété Name est affectée au paramètre Name de l’applet de commande. La valeur par défaut est false.

ValueFromRemainingArguments (paramètre nommé System.Boolean) Facultatif. True indique que le paramètre d’applet de commande accepte tous les arguments restants passés à l’applet de commande. La valeur par défaut est false.

HelpMessage (System.String) 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 (System.String) 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 ressources qui contient des messages d’aide que vous souhaitez localiser.

HelpMessageResourceId (System.String) Paramètre nommé facultatif. Spécifie l’identificateur de ressource d’un message d’aide.

DontShow (paramètre nommé System.Boolean) Facultatif. True indique que le paramètre est masqué par l’utilisateur pour l’extension de tabulation et IntelliSense. La valeur par défaut est false.

Remarques

  • Pour plus d’informations sur la déclaration de cet attribut, consultez Comment déclarer des paramètres d’applet de commande.

  • 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 champs ou propriétés non statiques publics. Les paramètres doivent être déclarés sur les propriétés. La propriété doit avoir un accesseur de jeu public et, si le mot clé ValueFromPipeline ou ValueFromPipelineByPropertyName 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 jeu de paramètres à moins de cinq. Et les paramètres positionnels n’ont pas besoin d’être contigus. Les postes 5, 100 et 250 fonctionnent de la même façon que les postes 0, 1 et 2.

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

  • Lorsque vous utilisez des jeux de paramètres, notez les éléments 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 plusieurs paramètres positionnels avec la même position.

    • Un seul paramètre d’un jeu de paramètres doit déclarer ValueFromPipeline = true.

    • Plusieurs paramètres peuvent définir ValueFromPipelineByPropertyName = true.

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

  • L’attribut de paramètre est défini par la classe System.Management.Automation.ParameterAttribute.

  • Le paramètre DontShow a les effets secondaires suivants :

    • Affecte tous les jeux de paramètres pour le paramètre associé, même s’il existe un jeu de paramètres dans lequel DontShow n’est pas utilisé.
    • Masque les paramètres courants de la saisie semi-automatique des onglets et IntelliSense. DontShow ne masque pas les paramètres communs facultatifs : WhatIf, Confirmerou UseTransaction.

Voir aussi

  • Last updated on