PowerShell Logo Small

Write-Debug



This is the built-in help made by Microsoft for the command 'Write-Debug', in PowerShell version 2 - as retrieved from Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Writes a debug message to the console.

SYNTAX


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



Search powershellhelp.space

DESCRIPTION


The Write-Debug cmdlet writes debug messages to the console from a script or command.

By default, debug messages are not displayed in the console, but you can display them by using the Debug parameter or the $DebugPreference variab
le.



<

RELATED LINKS

Online version: http://go.microsoft.com/fwlink/?LinkID=113424
Write-Verbose
Write-Error
Write-Host
Write-Progress
Write-Output
Write-Warning

REMARKS

<

Examples


-------------------------- EXAMPLE 1 --------------------------

C:\PS>Write-Debug "Cannot open file."



Description
-----------
This command writes a debug message. Because the value of $DebugPreference is "SilentlyContinue", the message is not displayed in the console.








-------------------------- EXAMPLE 2 --------------------------

C:\PS>$DebugPreference

SilentlyContinue

C:\PS> Write-Debug "Cannot open file."
C:\PS>

C:\PS> Write-Debug "Cannot open file." -debug
DEBUG: Cannot open file.



Description
-----------
This example shows how to use the Debug common parameter to override the value of the $DebugPreference variable for a particular command.

The first command displays the value of the $DebugPreference variable, which is "SilentlyContinue", the default.

The second command writes a debug message but, because of the value of $DebugPreference, the message does not appear.

The third command writes a debug message. It uses the Debug common parameter to override the value of $DebugPreference and to display the debug m
essages resulting from this command.

As a result, even though the value of $DebugPreference is "SilentlyContinue", the debug message appears.


For more information about the Debug common parameter, see about_CommonParameters.








-------------------------- EXAMPLE 3 --------------------------

C:\PS>$DebugPreference

SilentlyContinue

C:\PS> Write-Debug "Cannot open file."
C:\PS>

C:\PS> $DebugPreference = "Continue"

C:\PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.



Description
-----------
This command shows the effect of changing the value of the $DebugPreference variable on the display of debug messages.

The first command displays the value of the $DebugPreference variable, which is "SilentlyContinue", the default.

The second command writes a debug message but, because of the value of $DebugPreference, the message does not appear.

The third command assigns a value of "Continue" to the $DebugPreference variable.

The fourth command writes a debug message, which appears on the console.

For more information about $DebugPreference, see about_Preference_Variables.