Cmdlet.WriteDebug(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 -> unitPublic Sub WriteDebug (text As String)Parameters
- text
- String
Debug output.
Exceptions
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.
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.