Partager via


Write-Warning

Écrit un message d'avertissement.

Syntaxe

Write-Warning
     [-Message] <String>
     [<CommonParameters>]

Description

L’applet Write-Warning de commande écrit un message d’avertissement sur l’hôte PowerShell. La réponse à l’avertissement dépend de la valeur de la variable de $WarningPreference l’utilisateur et de l’utilisation du paramètre commun WarningAction .

Exemples

Exemple 1 : Écrire un message d’avertissement

Cette commande affiche le message « AVERTISSEMENT : Il s’agit uniquement d’un avertissement de test ».

Write-Warning "This is only a test warning."

Exemple 2 : Passer une chaîne à l’avertissement en écriture

Cette commande montre que vous pouvez utiliser un opérateur de pipeline (|) pour envoyer une chaîne à 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.

$w = "This is only a test warning."
$w | Write-Warning

Exemple 3 : Définir la variable $WarningPreference et écrire un avertissement

Cet exemple montre l’effet de la valeur de la $WarningPreference variable sur une Write-Warning commande.

PS> $WarningPreference
Continue
PS> Write-Warning "This is only a test warning."
This is only a test warning.
PS> $WarningPreference = "SilentlyContinue"
PS> Write-Warning "This is only a test warning."
PS> $WarningPreference = "Stop"
PS> Write-Warning "This is only a test warning."
WARNING: This is only a test warning.
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 warning."

La première commande affiche la valeur par défaut de la $WarningPreference variable, qui est Continue. Par conséquent, lorsque vous écrivez un avertissement, le message d'avertissement s'affiche et l'exécution se poursuit.

Lorsque vous modifiez la valeur de la $WarningPreference variable, l’effet de la Write-Warning commande change à nouveau. Valeur de suppression de SilentlyContinue l’avertissement. Une valeur d’affichage de Stop 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 : Définir le paramètre WarningAction et écrire un avertissement

Cet exemple montre l’effet du paramètre commun WarningAction sur une Write-Warning commande. Vous pouvez utiliser le paramètre commun WarningAction avec n’importe quelle applet de commande pour déterminer comment PowerShell répond aux avertissements résultant de cette commande. Le paramètre commun WarningAction remplace la valeur de la $WarningPreference seule commande particulière.

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"):

Cette commande utilise l’applet Write-Warning de commande pour afficher un avertissement. Le paramètre commun WarningAction avec une valeur de Inquire dirige le système pour inviter l’utilisateur lorsque la commande affiche un avertissement.

Pour plus d’informations sur le paramètre commun WarningAction , consultez about_CommonParameters.

Paramètres

-Message

Spécifie le message d'avertissement.

Type:String
Alias:Msg
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

String

Vous pouvez diriger une chaîne qui contient l’avertissement vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne pas de sortie. Il écrit uniquement dans le flux d’avertissement.

Notes

La valeur par défaut de la $WarningPreference variable est Continue, qui affiche l’avertissement, puis continue d’exécuter la commande. Pour déterminer les valeurs valides d’une variable de préférence telle que $WarningPreference, définissez-la sur une chaîne de caractères aléatoires, comme « abc ». Le message d’erreur résultant répertorie les valeurs valides.