Share via

NewPSSessionOptionCommand.CancelTimeout Property

  • Reference

Definition

Namespace:
Microsoft.PowerShell.Commands
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0

The duration for which PowerShell should wait (in milliseconds) before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The user wouldn’t mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the user a feeling that the PowerShell client has hung.

public:
 property int CancelTimeout { int get(); void set(int value); };
public:
 property int CancelTimeout { int get(); void set(int value); };
public int CancelTimeout { get; set; }
[System.Management.Automation.Alias(new System.String[] { "CancelTimeoutMSec" })]
[System.Management.Automation.Parameter]
[System.Management.Automation.ValidateRange(0, 2147483647)]
public int CancelTimeout { get; set; }
member this.CancelTimeout : int with get, set
[<System.Management.Automation.Alias(new System.String[] { "CancelTimeoutMSec" })>]
[<System.Management.Automation.Parameter>]
[<System.Management.Automation.ValidateRange(0, 2147483647)>]
member this.CancelTimeout : int with get, set
Public Property CancelTimeout As Integer

Property Value

Int32
Attributes
AliasAttribute ParameterAttribute ValidateRangeAttribute

Applies to