Partager via


Write-Debug

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

Syntaxe

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

Description

L’applet de commande Write-Debug écrit des messages de débogage dans la console à 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 de débogage ou de la variable .

Exemples

Exemple 1 : Comprendre $DebugPreference

Cet exemple écrit un message de débogage.

Write-Debug "Cannot open file."

La valeur par défaut de $DebugPreference est 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 variable $DebugPreference. Tout d’abord, nous affichons la valeur actuelle de $DebugPreference et essayons d’écrire un message de débogage. Ensuite, nous changeons la valeur de $DebugPreference en 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 fonction Test-Debug écrit la valeur de la variable $DebugPreference sur l’hôte PowerShell et dans le flux de débogage. Dans cet exemple, nous utilisons le paramètre de débogage pour remplacer la valeur $DebugPreference.

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 de change lorsque vous utilisez le paramètre de débogage . Cette modification affecte uniquement l’étendue de la fonction. La valeur n’est pas affectée en dehors de la fonction.

Note

Lorsque la valeur de $DebugPreference est Inquire, PowerShell arrête 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 qui contient un message de débogage vers Write-Debug.

Sorties

None

Write-Debug écrit uniquement dans le flux de débogage. Elle ne retourne aucune sortie.