PSHost.SetShouldExit(Int32) Method

  • Reference

Definition

Namespace:
System.Management.Automation.Host
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

Request by the engine to end the current engine runspace (to shut down and terminate the host's root runspace).

public:
 abstract void SetShouldExit(int exitCode);
public:
 abstract void SetShouldExit(int exitCode);
 abstract void SetShouldExit(int exitCode);
public abstract void SetShouldExit (int exitCode);
abstract member SetShouldExit : int -> unit
Public MustOverride Sub SetShouldExit (exitCode As Integer)

Parameters

exitCode
Int32

The exit code accompanying the exit keyword. Typically, after exiting a runspace, a host will also terminate. The exitCode parameter can be used to set the host's process exit code.

Remarks

This method is called by the engine to request the host shutdown the engine. This is invoked by the exit keyword or by any other facility by which a runspace instance wishes to be shut down.

To honor this request, the host should stop accepting and submitting commands to the engine and close the runspace.

Applies to