RUBRIQUE
about_Functions_CmdletBindingAttribute
DESCRIPTION COURTE
Décrit un attribut qui déclare une fonction agissant comme une
applet de commande compilée.
DESCRIPTION LONGUE
Lorsque vous écrivez des fonctions, vous pouvez ajouter l'attribut
CmdletBinding pour que Windows PowerShell lie les paramètres de la
fonction comme il lie les paramètres des applets de commande
compilées. Lorsque cet attribut est déclaré, Windows PowerShell
définit également la variable automatique $PSCmdlet.
Lorsque vous utilisez la liaison d'applets de commande, les paramètres
inconnus et les arguments positionnels sans paramètre positionnel
correspondant entraînent l'échec de la liaison des paramètres. De
même, une fonction ou un script avec liaison d'applets de commande
n'utilise pas la variable $args.
Remarque : les applets de commande compilées utilisent l'attribut
Cmdlet obligatoire, semblable à l'attribut CmdletBinding
décrit dans cette rubrique.
L'exemple suivant affiche le plan d'une fonction qui spécifie tous les
arguments facultatifs de l'attribut CmdletBinding. Une brève
description de chaque argument suit cet exemple.
{
[CmdletBinding(SupportsShouldProcess=<Booléen>,
ConfirmImpact=<Chaîne>,
DefaultParameterSetName=<Chaîne>)]
Param ($Parameter1)
Begin{}
Process{}
End{}
}
SupportsShouldProcess
Lorsque l'argument SupportsShouldProcess est défini sur la
valeur true, il indique que la fonction prend en charge les
appels à la méthode ShouldProcess, utilisée pour inviter
l'utilisateur à fournir des commentaires avant que la fonction
n'apporte une modification au système. Lorsque cet argument est
spécifié, les paramètres Confirm et WhatIf sont activés pour la
fonction.
Pour plus d'informations sur les demandes de confirmation, consultez
" Requesting Confirmation " (en anglais) dans la bibliothèque MSDN
(Microsoft Developer Network) à l'adresse
https://go.microsoft.com/fwlink/?LinkId=136658.
DefaultParameterSetName
L'argument DefaultParameterSetName spécifie le nom du jeu de
paramètres que Windows PowerShell essaiera d'utiliser lorsqu'il
ne pourra pas déterminer quel jeu de paramètres utiliser. Vous
pouvez éviter ce problème en faisant du paramètre unique de
chaque jeu de paramètres un paramètre obligatoire.
ConfirmImpact
L'argument ConfirmImpact spécifie le moment auquel l'action de
la fonction doit être confirmée par un appel à la méthode
ShouldProcess. L'appel à la méthode ShouldProcess affiche une
demande de confirmation uniquement lorsque l'argument ConfirmImpact
est égal ou supérieur à la valeur de la variable de préférence
$ConfirmPreference. (La valeur par défaut de l'argument est
Medium (Moyen).) Spécifiez cet argument uniquement lorsque
l'argument SupportsShouldProcess est également spécifié.
VOIR AUSSI
about_Functions_Advanced
about_Functions_CmdletBindingAttribute
about_Functions_ParameterAttributes