Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Cmdlet.WriteCommandDetail Method (String)

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Writes information to the execution log of the pipeline.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

public void WriteCommandDetail(
	string text
)

Parameters

text
Type: System.String

Text to be written to the execution log.

Exception Condition
PipelineStoppedException

The pipeline is stopped. The pipeline was terminated either before the call was made or while the call was in progress. By default, the cmdlet should allow the caller of the processing record method to catch this exception.

Also, if the pipeline was terminated because of ActionPreference.Stop or ActionPreference.Inquire, the command failure will ultimately be ActionPreferenceStopException.

InvalidOperationException

The call cannot be completed at this time or cannot be completed from this thread. For more information, see the following Remarks section.

Use this method to write important information about the execution of the cmdlet to the pipeline execution log. If LogPipelineExecutionDetail is turned on, this information will be written to the Windows PowerShell log under the log category "Pipeline execution detail."

This method can be called only from within the cmdlet implementation of the BeginProcessing, ProcessRecord, and EndProcessing methods and only from that thread. If this call is made from outside these implementations or from another thread, an InvalidOperationException exception is thrown.

Return to top

Community Additions

Show:
© 2016 Microsoft