PipelineStoppedException Class
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.
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
- Attributes
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) |