Compartir a través de

PipelineStoppedException Class

  • 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

Indicates that the pipeline has already been stopped.

public ref class PipelineStoppedException : System::Management::Automation::RuntimeException
[System.Serializable]
public class PipelineStoppedException : System.Management.Automation.RuntimeException
public class PipelineStoppedException : System.Management.Automation.RuntimeException
[<System.Serializable>]
type PipelineStoppedException = class
    inherit RuntimeException
type PipelineStoppedException = class
    inherit RuntimeException
Public Class PipelineStoppedException
Inherits RuntimeException
Inheritance
SystemException
RuntimeException
PipelineStoppedException
Attributes
SerializableAttribute

Remarks

When reported as the result of a command, PipelineStoppedException indicates that the command was stopped asynchronously, either by the user hitting CTRL-C, or by a call to Stop().

When a cmdlet or provider sees this exception thrown from a PowerShell API such as WriteObject(object) this means that the command was already stopped. The cmdlet or provider should clean up and return. Catching this exception is optional; if the cmdlet or providers chooses not to handle PipelineStoppedException and instead allow it to propagate to the PowerShell Engine's call to ProcessRecord, the PowerShell Engine will handle it properly.

Constructors

PipelineStoppedException()

Instantiates a new instance of the PipelineStoppedException class.
PipelineStoppedException(SerializationInfo, StreamingContext)
Obsolete.

Initializes a new instance of the PipelineStoppedException class using data serialized via ISerializable
PipelineStoppedException(String, Exception)

Instantiates a new instance of the PipelineStoppedException class.
PipelineStoppedException(String)

Instantiates a new instance of the PipelineStoppedException class.

Properties

ErrorRecord

Additional information about the error.

(Inherited from RuntimeException)
WasThrownFromThrowStatement (Inherited from RuntimeException)

Methods

GetObjectData(SerializationInfo, StreamingContext)

Serializer for ISerializable

(Inherited from RuntimeException)

Applies to