Partager via

Write-Debug

  • Référence
Module:
Microsoft.PowerShell.Utility

Écrit un message de débogage dans la console.

Syntaxe

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

Description

L’applet Write-Debug de commande écrit des messages de débogage sur l’hôte à partir d’un script ou d’une commande.

Par défaut, les messages de débogage ne sont pas affichés dans la console, mais vous pouvez les afficher à l’aide du paramètre Debug ou de la $DebugPreference variable.

Exemples

Exemple 1 : Comprendre $DebugPreference

Cet exemple écrit un message de débogage.

Write-Debug "Cannot open file."

La valeur par défaut est $DebugPreference SilentlyContinue. Par conséquent, le message n’est pas affiché dans la console.

Exemple 2 : Modifier la valeur de $DebugPreference

Cet exemple montre l’effet de la modification de la valeur de la $DebugPreference variable. Tout d’abord, nous affichons la valeur actuelle et $DebugPreference essayons d’écrire un message de débogage. Ensuite, nous modifions la valeur de $DebugPreference Continuer, ce qui permet d’afficher les messages de débogage.

PS> $DebugPreference
SilentlyContinue
PS> Write-Debug "Cannot open file."
PS>
PS> $DebugPreference = "Continue"
PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.

Pour plus d’informations sur $DebugPreference, consultez about_Preference_Variables.

Exemple 3 : Utiliser le paramètre Debug pour remplacer $DebugPreference

La Test-Debug fonction écrit la valeur de la $DebugPreference variable dans l’hôte PowerShell et dans le flux de débogage. Dans cet exemple, nous utilisons le paramètre Debug pour remplacer la $DebugPreference valeur.

function Test-Debug {
    [CmdletBinding()]
    param()
    Write-Debug ('$DebugPreference is ' + $DebugPreference)
    Write-Host ('$DebugPreference is ' + $DebugPreference)
}

PS> Test-Debug
$DebugPreference is SilentlyContinue

PS> Test-Debug -Debug
DEBUG: $DebugPreference is Inquire

Confirm
Continue with this operation?
[Y] Yes  [A] Yes to All  [H] Halt Command  [?] Help (default is "Y"):
$DebugPreference is Inquire
PS> $DebugPreference
SilentlyContinue

Notez que la valeur des $DebugPreference modifications lorsque vous utilisez le paramètre Debug . Cette modification affecte uniquement l’étendue de la fonction. La valeur n’est pas affectée en dehors de la fonction.

Remarque

Lorsque la valeur de $DebugPreference l’objet Inquire est Inquire, PowerShell interrompt l’exécution pour demander si l’exécution doit continuer.

Pour plus d’informations sur le paramètre commun de débogage , consultez about_CommonParameters.

Paramètres

-Message

Spécifie le message de débogage à envoyer à la console.

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 contenant un message de débogage vers cette applet de commande.

Sorties

None

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