Cmdlet.WriteDebug(String) Method

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
Microsoft.WSMan.Runtime v7.0.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Display debug information

public:
 void WriteDebug(System::String ^ text);
public:
 void WriteDebug(Platform::String ^ text);
void WriteDebug(std::wstring const & text);
public void WriteDebug (string text);
member this.WriteDebug : string -> unit
Public Sub WriteDebug (text As String)

Parameters

text
String

debug output

Exceptions

PipelineStoppedException

The pipeline has already been terminated, or was terminated during the execution of this method. The Cmdlet should generally just allow PipelineStoppedException to percolate up to the caller of ProcessRecord etc.

InvalidOperationException

Not permitted at this time or from this thread. WriteDebug may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread.

Remarks

Use WriteDebug to display debug information on the inner workings

of your Cmdlet. By default, debug output will

not be displayed, although this can be configured with the

DebugPreference shell variable or the -Debug command-line option.

Applies to

See also