ScheduledJobOptionCmdletBase.IdleTimeout Property

  • Article

Gets or sets the IdleTimeout cmdlet parameter value, which specifies how long Task Scheduler waits for the computer to become idle after a trigger has activated before canceling a job that is scheduled to be run during computer idle time. This SDK programming element is introduced in Windows PowerShell 3.0.

Namespace: Microsoft.PowerShell.ScheduledJob
Assembly: Microsoft.PowerShell.ScheduledJob (in Microsoft.PowerShell.ScheduledJob.dll)

Usage

'Usage
Dim instance As ScheduledJobOptionCmdletBase
Dim value As TimeSpan

value = instance.IdleTimeout

instance.IdleTimeout = value

Syntax

'Declaration
<ParameterAttribute(ParameterSetName:="Options")> _
Public Property IdleTimeout As TimeSpan

[ParameterAttribute(ParameterSetName="Options")] 
public TimeSpan IdleTimeout { get; set; }

[ParameterAttribute(ParameterSetName=L"Options")] 
public:
property TimeSpan IdleTimeout {
    TimeSpan get ();
    void set (TimeSpan value);
}

/** @property */
public TimeSpan get_IdleTimeout ()

/** @property */
public void set_IdleTimeout (TimeSpan value)

public function get IdleTimeout () : TimeSpan

public function set IdleTimeout (value : TimeSpan)

Property Value

Returns TimeSpan.

Thread Safety

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

Platforms

Target Platforms

See Also

Reference

ScheduledJobOptionCmdletBase Class
ScheduledJobOptionCmdletBase Members
Microsoft.PowerShell.ScheduledJob Namespace