Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Write-Debug

Updated: August 9, 2015

Write-Debug

Writes a debug message to the console.

Syntax

Parameter Set: Default
Write-Debug [-Message] <String> [ <CommonParameters>]




Detailed 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 variable.

Parameters

-Message<String>

Specifies the debug message to send to the console.


Aliases

Msg

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe a string that contains a debug message to Write-Debug.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    Write-Debug writes only to the debug stream. It does not return any output.


Examples

Example 1: Understand $DebugPreference

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


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

Example 2: Use the Debug parameter to override $DebugPreference

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 messages 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.


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

Example 3: Change the value of $DebugPreference

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.


PS C:\> $DebugPreference
PS C:\>  Write-Debug "Cannot open file." 
PS C:\>
PS C:\> $DebugPreference = "Continue"
PS C:\> Write-Debug "Cannot open file."

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft