Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ScheduledJobOptions Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represents Task Scheduler options. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

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

System.Object
  Microsoft.PowerShell.ScheduledJob.ScheduledJobOptions

[SerializableAttribute]
public sealed class ScheduledJobOptions : ISerializable

NameDescription
System_CAPS_pubmethodScheduledJobOptions()

Initializes a new instance of the ScheduledJobOptions class. Introduced in Windows PowerShell 3.0.

NameDescription
System_CAPS_pubpropertyDoNotAllowDemandStart

Gets or sets a value that indicates whether to allow a job to be started on demand. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyIdleDuration

Gets or sets how long the computer needs to be idle before a triggered job is started. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyIdleTimeout

Gets or sets how long Task Scheduler waits for the required idle duration before timing out of a job that is scheduled to be run during idle time. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyJobDefinition

Gets or sets the scheduled job definition that is associated with these options. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyMultipleInstancePolicy

Gets or sets Task Scheduler options for multiple running instances of the job. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRestartOnIdleResume

Gets or sets a value that indicates whether to restart a scheduled job when the computer becomes idle. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRunElevated

Gets or sets a value that indicates whether to run the scheduled job with the permissions of a member of the Administrators group on the computer on which the job runs. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRunWithoutNetwork

Gets or sets a value that indicates whether to run a scheduled job even if the network is not available. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyShowInTaskScheduler

Gets or sets a value that indicates whether to prevent the scheduled job from being displayed in Task Scheduler. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyStartIfNotIdle

Gets or sets a value that indicates whether to start the scheduled job only if the computer is not idle. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyStartIfOnBatteries

Gets or sets a value that indicates whether to start a scheduled job even if the computer is running on battery power. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyStopIfGoingOffIdle

Gets or sets a value that indicates whether to suspend a job that has already been started by Task Scheduler if the computer is no longer idle. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyStopIfGoingOnBatteries

Gets or sets a value that indicates whether to suspend a scheduled job if the computer is going to switch from AC power to battery power. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyWakeToRun

Gets or sets a value that indicates whether to wake the computer from a Hibernate or Sleep state to run the scheduled job if the computer is in sleep mode when the job trigger is activated. Introduced in Windows PowerShell 3.0.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Populates an object with the data needed to serialize the scheduled job options. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdateJobDefinition()

Updates the associated scheduled job definition with the current job options. Introduced in Windows PowerShell 3.0.

This class can be serialized.

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

Return to top
Show: