Cmdlet.WriteCommandDetail(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

Write text into pipeline execution log.

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

Parameters

text
String

text to be written to log

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. WriteWarning may only be called during a call to this Cmdlet's implementation of ProcessRecord, BeginProcessing or EndProcessing, and only from that thread.

Remarks

Use WriteCommandDetail to write important information about cmdlet execution to

pipeline execution log.

If LogPipelineExecutionDetail is turned on, this information will be written

to monad log under log category "Pipeline execution detail"

Applies to

See also