Task Scheduler Scripting Objects

  • Article

The scripting objects that are described in the following topics provide programmatic access to the functionality that is available within the Task Scheduler for Visual Basic and Visual Basic script developers.

The following objects are introduced in Task Scheduler 2.0.

Object Description
Action Provides the common properties that are inherited by all action objects.
ActionCollection Contains the actions performed by the task.
BootTrigger Represents a trigger that starts a task when the system is booted.
ComHandlerAction Represents an action that fires a handler.
DailyTrigger Represents a trigger that starts a task based on a daily schedule.
EmailAction Represents an action that sends an email message.
EventTrigger Represents a trigger that starts a task when a system event occurs.
ExecAction Represents an action that executes a command-line operation.
IdleSettings Specifies how the Task Scheduler performs tasks when the computer is in an idle condition.
IdleTrigger Represents a trigger that starts a task when an idle condition occurs.
LogonTrigger Represents a trigger that starts a task when a user logs on.
MonthlyDOWTrigger Represents a trigger that starts a task on a monthly day-of-week schedule.
MonthlyTrigger Represents a trigger that starts a task based on a monthly schedule.
NetworkSettings Provides the settings that the Task Scheduler service uses to obtain a network profile.
Principal Provides the security credentials for a principal.
RegisteredTask Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials that are used to register the task, and the properties that describe the task.
RegisteredTaskCollection Contains all the tasks that are registered.
RegistrationInfo Provides the administrative information that can be used to describe the task. This information includes details such as a description of the task, the author of the task, the date the task is registered, and the security descriptor of the task.
RegistrationTrigger Represents a trigger that starts a task when the task is registered.
RepetitionPattern Defines how often the task is run and how long the repetition pattern is repeated after the task is started.
RunningTask Provides the methods to get information from and control a running task.
RunningTaskCollection Used to retrieve a running task.
SessionStateChangeTrigger Used to trigger tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications.
ShowMessageAction Represents an action that shows a message box when a task is activated.
TaskDefinition Defines all the components of a task, such as the task settings, triggers, actions, and registration information.
TaskFolder Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder.
TaskFolderCollection Counts the number of folders in the collection and retrieve a specified folder from the collection.
TaskNamedValuePair Creates a name-value pair in which the name is associated with the value.
TaskNamedValueCollection Contains a collection of TaskNamedValuePair object name-value pairs.
TaskService Provides access to the Task Scheduler service for managing registered tasks.
TaskSettings Provides the settings that the Task Scheduler services uses to perform the task.
TaskVariables Defines task variables that can be passed as parameters to task handlers and external executables that are launched by tasks.
TimeTrigger Represents a trigger that starts a task when the trigger is activated.
Trigger Provides the common properties that are inherited by all trigger objects.
TriggerCollection Used to add to, remove from, and retrieve the triggers of a task.
WeeklyTrigger Represents a trigger that starts a task based on a weekly schedule.

 

Task Scheduler Reference

Task Scheduler