Cmdlet.WriteError(ErrorRecord) Method

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

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.

Internal variant: Writes the specified error to the error pipe.

public:
 void WriteError(System::Management::Automation::ErrorRecord ^ errorRecord);

public void WriteError (System.Management.Automation.ErrorRecord errorRecord);

member this.WriteError : System.Management.Automation.ErrorRecord -> unit

Public Sub WriteError (errorRecord As ErrorRecord)

Parameters

errorRecord: ErrorRecord

Error.

Exceptions

InvalidOperationException

Not permitted at this time or from this thread

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.

Remarks

Do not call WriteError(e.ErrorRecord). The ErrorRecord contained in the ErrorRecord property of an exception which implements IContainsErrorRecord should not be passed directly to WriteError, since it contains a ParentContainsErrorRecordException rather than the real exception.

Applies to

Partilhar via