Cmdlet.WriteCommandDetail(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.
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 -> unitPublic Sub WriteCommandDetail (text As String)Parameters
- text
- String
Text to be written to log.
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. 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 PowerShell log under log category "Pipeline execution detail"