ScheduledJobOptionCmdletBase.StartIfIdle Property

  • Article

Gets or sets the state of the StartIfIdle cmdlet parameter, which starts a scheduled job if the computer is idle. 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 SwitchParameter

value = instance.StartIfIdle

instance.StartIfIdle = value

Syntax

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

[ParameterAttribute(ParameterSetName="Options")] 
public SwitchParameter StartIfIdle { get; set; }

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

/** @property */
public SwitchParameter get_StartIfIdle ()

/** @property */
public void set_StartIfIdle (SwitchParameter value)

public function get StartIfIdle () : SwitchParameter

public function set StartIfIdle (value : SwitchParameter)

Property Value

Returns SwitchParameter.

Remarks

This property starts the scheduled job if the computer has been idle for the time specified by the IdleDuration property, but before the time specified by the IdleTimeout property expires.

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