Cmdlet.Stopping Property

Gets an indicator that the pipeline is stopping. The pipeline can be stopped for numerous reasons, such as when the user has entered the key combination CTRL+C, a terminating error has occurred, the hosting application requested a stop, and so on.


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

'Usage
Dim instance As Cmdlet
Dim value As Boolean

value = instance.Stopping

public:
property bool Stopping {
	bool get ();
}
/** @property */
public boolean get_Stopping ()

public function get Stopping () : boolean

Property Value

A Boolean value that indicates true if the user has entered the key combination CTRL+C, a terminating error has occurred, the hosting application requested a stop, and so on. The default is false.

The cmdlet should implement the StopProcessing method to perform operations that are required before the pipeline processing is stopped.

For more information about cmdlets, see Windows PowerShell Cmdlets.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Target Platforms


Show:
© 2014 Microsoft