Export (0) Print
Expand All

IIdleTrigger interface

Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task Idle Conditions.

Members

The IIdleTrigger interface inherits from ITrigger. IIdleTrigger also has these types of members:

Properties

The IIdleTrigger interface has these properties.

PropertyAccess typeDescription

Enabled

Read/write

Inherited from the ITrigger interface. Gets or sets a Boolean value that indicates whether the trigger is enabled.

EndBoundary

Read/write

Inherited from the ITrigger interface. Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated.

ExecutionTimeLimit

Read/write

Inherited from the ITrigger interface. Gets or sets the maximum amount of time in which the task can be started by the trigger.

Id

Read/write

Inherited from the ITrigger interface. Gets or sets the identifier for the trigger.

Repetition

Read/write

Inherited from the ITrigger interface. Gets or sets a value that indicates how often the task is run and how long the repetition pattern is repeated after the task is started.

StartBoundary

Read/write

Inherited from the ITrigger interface. Gets or sets the date and time when the trigger is activated.

Type

Read-only

Inherited from the ITrigger interface. Retrieves the type of the trigger.

 

Remarks

An idle trigger will only trigger a task action if the computer goes into an idle state after the start boundary of the trigger.

When creating your own XML for a task, an idle trigger is specified using the IdleTrigger element of the Task Scheduler schema.

If a task is triggered by an idle trigger, then the WaitTimeout property of the IIdleSettings interface is ignored.

If the initial instance of a task with an idle trigger is still running, then the task is only launched once with no repetitions, even if multiple repetition is defined in the Repetition property. This behavior does not occur if the task stops by itself.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Taskschd.h

Library

Taskschd.lib

DLL

Taskschd.dll

See also

Task Scheduler Interfaces

 

 

Community Additions

ADD
Show:
© 2014 Microsoft