Write-Debug - PowerShell command help and examples

Writes a debug message to the console. (Write-Debug)


NAME
Write-Debug
SYNOPSIS
Writes a debug message to the console.
SYNTAX
Write-Debug [-Message] <string> [<CommonParameters>]
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. Required? true Position? 1 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false <CommonParameters> This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, type, "get-help about_commonparameters".
INPUTS
System.String You can pipe a string that contains a debug message to Write-Debug.
OUTPUTS
None Write-Debug writes only to the debug stream. It does not return any output.
NOTES

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 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.
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. RELATED LINKS Online version: http://go.microsoft.com/fwlink/?LinkID=113424 Write-Verbose Write-Error Write-Host Write-Progress Write-Output Write-Warning C:\Windows>powershell get-help Write-Verbose -full

Microsoft Windows [Version 10.0.19045.3693]
Copyright (c) 2023 Microsoft Corporation.

ColorConsole [Version 3.7.1000] PowerShell 2.0-Export

Windows 11, 10, 8.1, 8, 7 / Server 2022, 2019, 2016











Windows-10


... Windows 10 FAQ
... Windows 10 How To


Windows 10 How To


... Windows 11 How To
... Windows 10 FAQ



PowerShell: Writes a debug message to the console.

HTTP: ... PS_Windows/en/Write-Debug.htm
0.061
12522

Deactivate recently added apps in the Windows 10/11 start menu!

Download free text editing program!

Find Advanced display Settings on Windows 10 / 11 and server!

Free text reading tool for Windows 11, 10, ...! 

How can I resize text, icons, and apps in Windows 10/11?

Try the Dark Theme on Windows 11 and 10!



(0)