Écrit un message d'avertissement.
Syntaxe
Write-Warning [-Message] <string> [<CommonParameters>]
Description
L'applet de commande Write-Warning écrit un message d'avertissement sur l'hôte Windows PowerShell. La réponse à cet avertissement dépend de la valeur de la variable $WarningPreference de l'utilisateur et de l'utilisation du paramètre courant WarningAction.
Paramètres
-Message <string>
Spécifie le message d'avertissement.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue) |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.String Vous pouvez diriger une chaîne contenant l'avertissement vers Write-Warning. |
|
Sorties |
Aucun Write-Warning écrit uniquement dans le flux d'avertissement. Elle ne génère aucune autre sortie. |
Remarques
La valeur par défaut de la variable $WarningPreference est « Continue », qui affiche l'avertissement, puis continue à exécuter la commande. Pour déterminer les valeurs valides d'une variable de préférence telle que $WarningPreference, définissez-la sous la forme d'une chaîne de caractères aléatoires, telle que « abc ». Le message d'erreur obtenu listera les valeurs valides.
Exemple 1
C:\PS>write-warning "This is only a test warning." Description ----------- Cette commande affiche le message « WARNING: This is only a test warning. »
Exemple 2
C:\PS>$w = "This is only a test warning." C:\PS> $w | write-warning Description ----------- Cet exemple montre que vous pouvez utiliser un opérateur de pipeline (|) pour envoyer une chaîne à l'applet de commande Write-Warning. Vous pouvez enregistrer la chaîne dans une variable, comme indiqué dans cette commande, ou diriger la chaîne directement vers Write-Warning.
Exemple 3
C:\PS>$warningpreference Continue C:\PS> write-warning "This is only a test warning." This is only a test warning. C:\PS> $warningpreference = "SilentlyContinue" C:\PS> write-warning "This is only a test warning." C:\PS> C:\PS> $warningpreference = "Stop" C:\PS> write-warning "This is only a test warning." WARNING: This is only a test message. Write-Warning : Command execution stopped because the shell variable "WarningPreference" is set to Stop. At line:1 char:14 + write-warning <<<< "This is only a test message." Description ----------- Cet exemple montre le résultat de la valeur de la variable $WarningPreference sur une commande Write-Warning. La première commande affiche la valeur par défaut de la variable $WarningPreference, qui est « Continue ». Par conséquent, lorsque vous écrivez un avertissement, le message s'affiche et l'exécution continue. Lorsque vous modifiez la valeur de la variable $WarningPreference, le résultat de la commande Write-Warning change à nouveau. La valeur « SilentlyContinue » supprime l'avertissement. La valeur « Stop » affiche l'avertissement, puis arrête l'exécution de la commande. Pour plus d'informations sur la variable $WarningPreference, consultez about_Preference_Variables.
Exemple 4
C:\PS>write-warning "This is only a test warning." -warningaction Inquire WARNING: This is only a test warning. Confirm Continue with this operation? [Y] Yes [A] Yes to All [H] Halt Command [S] Suspend [?] Help (default is "Y"): Description ----------- Cet exemple montre le résultat du paramètre courant WarningAction sur une commande Write-Warning. Vous pouvez utiliser le paramètre courant WarningAction avec n'importe quelle applet de commande afin de déterminer comment Windows PowerShell répond aux avertissements qui résultent de cette commande. Le paramètre courant WarningAction remplace la valeur de la variable $WarningPreference uniquement pour cette commande spécifique. Cette commande utilise l'applet de commande Write-Warning pour afficher un avertissement. Le paramètre courant WarningAction avec la valeur « Inquire » demande au système d'avertir l'utilisateur lorsque la commande affiche un avertissement. Pour plus d'informations sur le paramètre courant WarningAction, consultez about_CommonParameters.
Voir aussi