Task Objects

These Inspectors help you write Relevance expressions to deal with the Windows Task Manager and its various triggers.

task definition

The <task definition> Inspectors give access to the components of a task, such as the settings, triggers, actions and registration information.

Creation Methods

Declaration	Description	Platforms (?)
definition of <scheduled task>	Returns the task definition for the specified scheduled task for both the 1.0 and 2.0 interface.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
action of <task definition>	<task action> Plural: actions	Returns the action(s) performed by the task specified by the given definition.	Win:8.0
data of <task definition>	<string> Plural: datas	Returns the data associated with the task specified by the given definition.	Win:8.0
principal of <task definition>	<task principal> Plural: principals	Returns the principle for the task that provides the security credentials for the task associated with the specified task definition.	Win:8.0
registration info of <task definition>	<task registration info> Plural: registration infos	Returns data such as the author & date of registration associated with the specified task definition.	Win:8.0
setting of <task definition>	<task settings> Plural: settings	Returns the settings associated with the given task. These settings include dealing with starts, restarts and stops, how to manage hidden or multiple tasks, etcetera.	Win:8.0
trigger of <task definition>	<task trigger> Plural: triggers	Returns the triggers associated with the specified task definition.	Win:8.0
xml of <task definition>	<string> Plural: xmls	Returns the XML-formatted definition of the task associated with the specified task definition.	Win:8.0

task settings

The <task settings> Inspectors examine the settings used by the Task Scheduler service to perform the task. These settings include dealing with starts, restarts and stops, how to manage hidden or multiple tasks, and more.

Creation Methods

Declaration	Description	Platforms (?)
setting of <task definition>	Returns the settings associated with the given task. These settings include dealing with starts, restarts and stops, how to manage hidden or multiple tasks, etcetera.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
allow demand start of <task settings>	<boolean> Plural: allow demand starts	Returns TRUE if the task can be started by using the run command or the context menu.	Win:8.0
allow hard terminate of <task settings>	<boolean> Plural: allow hard terminates	Returns TRUE if the task can be terminated by using TerminateProcess.	Win:8.0
at compatibility of <task settings>	<boolean> Plural: at compatibilities	Returns TRUE if the task scheduler is compatible with AT. Tasks compatible with AT are only allowed to have a single time trigger.	Win:8.0
delete expired task after of <task settings>	<time interval> Plural: delete expired task afters	Returns a time interval that the Task Scheduler will wait after expiration before deleting the task.	Win:8.0
disallow start when on battery of <task settings>	<boolean> Plural: disallow start when on batteries	Returns TRUE if the task will not be started when the computer is running on battery power.	Win:8.0
enabled of <task settings>	<boolean> Plural: enableds	Returns TRUE if the task is enabled. The task associated with the specified settings can be performed only when this setting is TRUE.	Win:8.0
execution time limit of <task settings>	<time interval> Plural: execution time limits	Returns a time interval corresponding to the amount of time allowed to complete the task.	Win:8.0
hidden of <task settings>	<boolean> Plural: hiddens	Returns TRUE if the task will not be visible in the UI. Administrators can override this setting with a master switch that forces all tasks to be visible.	Win:8.0
idle setting of <task settings>	<task idle settings> Plural: idle settings	Returns the Idle Settings of the specified task. These can include:Idle durationRestart On IdleStop On Idle EndWait Timeout.	Win:8.0
ignore new instance of <task settings>	<boolean> Plural: ignore new instances	Returns TRUE if the MultipleInstances task setting is TASK_INSTANCES_IGNORE_NEW. This instructs the scheduler not to start a new instance of the task if the task is already running.	Win:8.0
network setting of <task settings>	<task network settings> Plural: network settings	Returns a task network settings object containing a network profile ID and name. If this setting exists and the 'run only when network available' property is TRUE, the task will wait to execute until the specified network profile is available.	Win:8.0
parallel instance of <task settings>	<boolean> Plural: parallel instances	Returns TRUE if the MultipleInstances task setting is TASK_INSTANCES_PARALLEL. This instructs the scheduler to go ahead and start a new instance of the task while the task is already running.	Win:8.0
priority of <task settings>	<integer> Plural: priorities	Returns the numeric priority level of the associated task.	Win:8.0
queue instance of <task settings>	<boolean> Plural: queue instances	Returns TRUE if the MultipleInstances task setting is TASK_INSTANCES_QUEUE. This instructs the scheduler to start a new instance of the task only after all existing instances are completed.	Win:8.0
restart count of <task settings>	<integer> Plural: restart counts	Returns the number of times that the Task Scheduler will attempt to restart the associated task.	Win:8.0
restart interval of <task settings>	<time interval> Plural: restart intervals	Returns a time interval quantifying how much time the Task Scheduler will allocate to restarting the associated task.	Win:8.0
run only when idle of <task settings>	<boolean> Plural: run only when idles	Returns TRUE if the Task Scheduler is set to run the associated task only from an idle computer.	Win:8.0
run only when network available of <task settings>	<boolean> Plural: run only when network availables	Returns TRUE if the Task Scheduler is set to run the task only when a network is available. If the 'network setting' exists, the task will be launched only when that network becomes available.	Win:8.0
start when available of <task settings>	<boolean> Plural: start when availables	Returns TRUE if the Task Scheduler is allowed to start the task any time after its scheduled time has lapsed.	Win:8.0
stop existing instance of <task settings>	<boolean> Plural: stop existing instances	Returns TRUE if the MultipleInstances task setting is TASK_INSTANCES_STOP_EXISTING. This instructs the scheduler to stop an existing instance of the task before starting a new instance.	Win:8.0
stop when going on battery of <task settings>	<boolean> Plural: stop when going on batteries	Returns TRUE if the task should be stopped whenever the computer starts to run on battery power.	Win:8.0
v1 compatibility of <task settings>	<boolean> Plural: v1 compatibilities	Returns TRUE if the specified task setting is compatible with version 1.0 of the scheduler.	Win:8.0
v2 compatibility of <task settings>	<boolean> Plural: v2 compatibilities	Returns TRUE if the specified task setting is compatible with version 2.0 of the scheduler.	Win:8.0
wake to run of <task settings>	<boolean> Plural: wake to runs	Returns TRUE if the Task Scheduler should wake the computer whenever it's time to start the task.	Win:8.0
xml of <task settings>	<string> Plural: xmls	Returns a string containing an XML-formatted version of the specified task settings.	Win:8.0

priority class

Threads are scheduled based on priority, which ranges from zero, the lowest, to 31, the highest. The zero-page thread, a system thread in charge of zeroing free pages when all other threads are finished, is the only thread allowed to have a priority of zero.

Creation Methods

Declaration	Description	Platforms (?)
above normal priority	A priority class constant signifying above normal priority.	Win:8.0
below normal priority	Returns a priority class object with 'below normal' priority. This applies to threads that can wait for other threads to complete before running. Threads with this status are in between idle and normal priority.	Win:8.0
high priority	Returns a priority class object with 'high' priority. These threads will steal processor time from other threads and should be used very carefully. Typically, they are used strictly for responding to time-critical events.	Win:8.0
idle priority	Returns a priority class object with 'idle' priority. Processes that monitor the Client, such as screen savers, typically use this priority to keep them from interrupting higher priority threads.	Win:8.0
normal priority	Returns a priority class object with 'normal' priority. This is the default priority class of a process.	Win:8.0
realtime priority	Returns a priority class object with 'realtime' priority. These threads should be sparingly used, since they may interrupt user input and some disk operations. They are typically used for short, time-sensitive communication with low level hardware.	Win:8.0
base priority of <process>	Refers to the base priority of the process, which determines the order in which threads are scheduled for the processor. The base priority is set by the process code (not the OS), however the OS sets and changes the dynamic priorities of threads in the process within the range of the base. Use the Task Manager to change the base priority of processes.	Win:8.0

Operators

Declaration	Return Type	Description	Platforms (?)
<priority class> = <priority class>	<boolean>	Returns TRUE if the two priority classes are the same.	Win:8.0

Properties

Declaration

Return type

Description

Platforms (?)

running task

This group of Inspectors is built on top of the Windows Task Scheduler (see the MSDN reference). They only work with the 2.0 interface (Win 7, Vista and Server 2008). The scheduler allows tasks to be run according to various criteria. These Inspectors provide information such as the name and action(s) of each running task.These Inspectors are for the 2.0 interface only.

Creation Methods

Declaration	Description	Platforms (?)
running task	Retrieves a list of all the currently running tasks, including hidden tasks. Example: running tasks - Returns a list of all currently running tasks, as determined by the Task Scheduler.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
current action of <running task>	<string> Plural: current actions	Returns the currently executing action of the specified running task.	Win:8.0
disabled state of <running task>	<boolean> Plural: disabled states	Returns TRUE if the specified running task is disabled.	Win:8.0
engine pid of <running task>	<integer> Plural: engine pids	Returns the process ID of the specified running task.	Win:8.0
instance guid of <running task>	<string> Plural: instance guids	Returns the globally unique identifier corresponding to the specified running task.	Win:8.0
name of <running task>	<string> Plural: names	Returns the name of the specified running task.	Win:8.0
path of <running task>	<string> Plural: paths	Returns the path associated with the specified running task.	Win:8.0
queued state of <running task>	<boolean> Plural: queued states	Returns TRUE if the specified running task is queued up.	Win:8.0
ready state of <running task>	<boolean> Plural: ready states	Returns TRUE if the specified running task is ready.	Win:8.0
running state of <running task>	<boolean> Plural: running states	Returns TRUE if the specified running task is running.	Win:8.0
unknown state of <running task>	<boolean> Plural: unknown states	Returns TRUE if the specified running task is unknown.	Win:8.0

task named value pair

The <task named value pair> Inspectors return name-value pairs associated with various aspects of a scheduled task.

Creation Methods

Declaration	Description	Platforms (?)
header field of <email task action>	Returns the header information (as named value pairs) from the email triggered by a scheduled task.	Win:8.0
value query of <event task trigger>	Returns a list of named XPath queries as name-value pairs. Each query in the list is applied to the last matching event XML returned from the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of a ShowMessage action.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
name of <task named value pair>	<string> Plural: names	Returns the string name(s) associated with the specified name-value pair(s).	Win:8.0
value of <task named value pair>	<string> Plural: values	Returns the string value(s) associated with the specified name-value pair(s).	Win:8.0

scheduled task

The <scheduled task> Inspectors are built on top of the Windows Task Scheduler (see the MSDN reference). There are two versions: the 1.0 interface (Win 2000, XP & Server 2003) and the 2.0 interface (Win 7, Vista and Server 2008) which is favored when available. The Task Scheduler Inspector set reflects the 2.0 interface layout which in turn maps back to the 1.0 interface. Features of the 1.0 interface are available in the 2.0 interface, but not vice-versa. If the 2.0 interface isn't available, you may encounter undefined objects. Each of these Inspectors works with both 1.0 and 2.0 unless explicitly Noted.

Creation Methods

Declaration	Description	Platforms (?)
first interface scheduled task	Returns a list of all the scheduled tasks.1.0 interface only.	Win:8.0
scheduled task	This Inspector is typically used to return a list of all scheduled tasks. It attempts to use the 2.0 interface first (which includes hidden tasks), then drops down to 1.0 if necessary.	Win:8.0
scheduled task <string>	Returns a scheduled task with the specified name. It attempts to use the 2.0 interface if available, otherwise it uses the 1.0 interface. This method only looks in the root folder for 2.0 tasks, whch include hidden tasks.	Win:8.0
descendant of <task folder>	Returns the descendant tasks, which include the tasks in the specified folder plus the tasks in all of its subfolders.	Win:8.0
scheduled task <string> of <task folder>	Returns the named scheduled task in the specified task folder.	Win:8.0
scheduled task of <task folder>	Returns a list of the scheduled tasks of the specified task folder. Example: scheduled tasks of task folder "\" - Returns the 2.0 interface list of scheduled tasks from the specified folder.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
definition of <scheduled task>	<task definition> Plural: definitions	Returns the task definition for the specified scheduled task for both the 1.0 and 2.0 interface.	Win:8.0
disabled state of <scheduled task>	<boolean> Plural: disabled states	Returns a boolean indicating the whether the specified task is disabled or not.	Win:8.0
enabled of <scheduled task>	<boolean> Plural: enableds	Returns a boolean TRUE if the specified scheduled task is enabled.	Win:8.0
last run time of <scheduled task>	<time> Plural: last run times	Returns the time corresponding to when the specified scheduled task was last run.	Win:8.0
last task result of <scheduled task>	<integer> Plural: last task results	Returns an integer corresponding to the last result of the specified scheduled task.	Win:8.0
missed run count of <scheduled task>	<integer> Plural: missed run counts	Returns an integer corresponding to the missed run count of the specified scheduled task.	Win:8.0
name of <scheduled task>	<string> Plural: names	Returns the name of the specified scheduled task.	Win:8.0
next run time of <scheduled task>	<time> Plural: next run times	Returns the next time that the specified task is scheduled to run.	Win:8.0
path of <scheduled task>	<string> Plural: paths	Returns the path of the specified scheduled task.2.0 interface only.	Win:8.0
queued state of <scheduled task>	<boolean> Plural: queued states	Returns a boolean indicating the whether the specified task is queued or not.	Win:8.0
ready state of <scheduled task>	<boolean> Plural: ready states	Returns a boolean indicating the whether the specified task is ready or not.	Win:8.0
running state of <scheduled task>	<boolean> Plural: running states	Returns a boolean indicating the whether the specified task is running or not.	Win:8.0
security descriptor of <scheduled task>	<security descriptor> Plural: security descriptors	Returns the security descriptor for the specified scheduled task.2.0 interface only.	Win:8.0
trigger string of <scheduled task>	<string> Plural: trigger strings	Returns the triggering string for the specified scheduled task.1.0 interface only.	Win:8.0
unknown state of <scheduled task>	<boolean> Plural: unknown states	Returns TRUE if the state of the scheduled task is unknown.2.0 interface only.	Win:8.0
xml of <scheduled task>	<string> Plural: xmls	Returns a string containing the XML content of the specified scheduled task. 2.0 interface only.	Win:8.0

task folder

The <task folder> objects provide the methods that are used to retrieve tasks from the folder, as well as from its subfolders. Task folders are specified by name, path and include scheduled tasks.

Creation Methods

Declaration	Description	Platforms (?)
task folder <string>	Gets the task folder with the given string name.	Win:8.0
task folder of <task folder>	Returns the subfolders of the given task folder.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
descendant of <task folder>	<scheduled task> Plural: descendants	Returns the descendant tasks, which include the tasks in the specified folder plus the tasks in all of its subfolders.	Win:8.0
name of <task folder>	<string> Plural: names	Returns the name(s) used to identify the folder that contains a task.	Win:8.0
path of <task folder>	<string> Plural: paths	Returns the path(s) to the location of the task folder(s).	Win:8.0
scheduled task <string> of <task folder>	<scheduled task> Plural: scheduled tasks	Returns the named scheduled task in the specified task folder.	Win:8.0
scheduled task of <task folder>	<scheduled task> Plural: scheduled tasks	Returns a list of the scheduled tasks of the specified task folder.	Win:8.0
security descriptor of <task folder>	<security descriptor> Plural: security descriptors	Returns the security descriptor for the specified task folder.	Win:8.0
task folder of <task folder>	<task folder> Plural: task folders	Returns the subfolders of the given task folder.	Win:8.0

task principal

The <task principal> Inspectors provide information about the scheduled task principal, which incapsulates the security credentials. The principal object includes a display name, a logon type, a run level and a set of IDs.

Creation Methods

Declaration	Description	Platforms (?)
principal of <task definition>	Returns the principle for the task that provides the security credentials for the task associated with the specified task definition.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
display name of <task principal>	<string> Plural: display names	Returns the name of the principal (as a string) that is displayed in the Task Scheduler UI.	Win:8.0
group id of <task principal>	<string> Plural: group ids	Returns the identifier of the user group (as a string) that is required to run the tasks associated with the principal.	Win:8.0
group logon of <task principal>	<boolean> Plural: group logons	Returns TRUE if the task logon type is set to group activation. In this case, the user ID speicifies the group.	Win:8.0
highest runlevel of <task principal>	<boolean> Plural: highest runlevels	Returns TRUE if the specfied task principle will be run with the highest privileges.	Win:8.0
id of <task principal>	<string> Plural: ids	Returns the identifier of the specified task principal as a string type.	Win:8.0
interactive token logon of <task principal>	<boolean> Plural: interactive token logons	Returns TRUE if the task logon type is set to interactive token, meaning the task will only run in an existing interactive session.	Win:8.0
interactive token password logon of <task principal>	<boolean> Plural: interactive token password logons	Returns TRUE if the task logon type is set to interactive token or password. If the user is logged on, the interactive token is used. Otherwise the password is used. The password must have been specified when the task was registered.	Win:8.0
lua runlevel of <task principal>	<boolean> Plural: lua runlevels	Returns TRUE if the specfied task principle will be run with the least privileged user account (LUA).	Win:8.0
none logon of <task principal>	<boolean> Plural: none logons	Returns TRUE if the logon method for the task principal is not specified. Used for non-NT credentials.	Win:8.0
password logon of <task principal>	<boolean> Plural: password logons	Returns TRUE if a password is used for logging on the user. The password must be supplied when the task is registered.	Win:8.0
s4u logon of <task principal>	<boolean> Plural: s4u logons	Returns TRUE if an existing interactive token is used to run the task. This requires the user to employ a service for user (S4U) logon. With S4U logons, no password is stored and neither network nor encrypted files can be accessed.	Win:8.0
service account logon of <task principal>	<boolean> Plural: service account logons	Returns TRUE if a service account is used as a login. This implies that the task is being initiated by a Local System, Local Service, or Network Service account in a security context.	Win:8.0
user id of <task principal>	<string> Plural: user ids	Returns the user identifier (as a string) required to run the tasks associated with the principal.	Win:8.0

task registration info

The <task registration info> objects provide the administrative information used to describe a scheduled task. This information includes details such as a description, the name of the author, the date the task was registered, and the security descriptor.

Creation Methods

Declaration	Description	Platforms (?)
registration info of <task definition>	Returns data such as the author & date of registration associated with the specified task definition.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
author of <task registration info>	<string> Plural: authors	Returns the author of the scheduled task included in the specified task registration information object.	Win:8.0
date of <task registration info>	<time> Plural: dates	Returns the registration date (as a time type) of the scheduled task included in the specified task registration information object.	Win:8.0
description of <task registration info>	<string> Plural: descriptions	Returns a string containing the description of the scheduled task included in the specified task registration information object.	Win:8.0
documentation of <task registration info>	<string> Plural: documentations	Returns a string containing any additional documentation pertaining to the scheduled task included in the specified task registration information object.	Win:8.0
security descriptor of <task registration info>	<security descriptor> Plural: security descriptors	Returns the security descriptor of the scheduled task referred to by the specified task registration information object.	Win:8.0
source of <task registration info>	<string> Plural: sources	Returns a string containing the source (component, service application or user) of the scheduled task referred to by the specified task registration information object.	Win:8.0
uri of <task registration info>	<string> Plural: uris	Returns a string containing the URI of the scheduled task referred to by the specified task registration information object.	Win:8.0
version of <task registration info>	<string> Plural: versions	Returns a string containing the version number of the scheduled task included in the specified task registration information object.	Win:8.0
xml of <task registration info>	<string> Plural: xmls	Returns a string containing the XML-formatted version of the specified task registration information object.	Win:8.0

task repetition pattern

The <task repetition pattern> Inspectors define how often a scheduled task should be run and determine how long the repetition pattern will be repeated after the task is initiated.

Creation Methods

Declaration	Description	Platforms (?)
repetition of <task trigger>	Returns a task repetition pattern corresponding to how often the task will run and how long the repetition pattern will be repeated after the task has been started.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
duration of <task repetition pattern>	<time interval> Plural: durations	Returns a time interval specifying how long the given task pattern is repeated.	Win:8.0
interval of <task repetition pattern>	<time interval> Plural: intervals	Returns a time interval corresponding to the time between each restart of the task.	Win:8.0
stop at duration end of <task repetition pattern>	<boolean> Plural: stop at duration ends	Returns TRUE if the task repetition pattern has reached the end of its run.	Win:8.0

task action

The <task action> Inspectors grant access to the set of scheduled task actions. Actions have an ID and a type. The action types include starting COM handles, executing programs, sending emails and displaying messages.

Creation Methods

Declaration	Description	Platforms (?)
action of <task definition>	Returns the action(s) performed by the task specified by the given definition.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
<task action> as com handler task action	<com handler task action>	Casts the specified task action as a com handler task action.	Win:8.0
<task action> as email task action	<email task action>	Casts the specified task action as an email action.	Win:8.0
<task action> as exec task action	<exec task action>	Casts the specified task action as an executable action.	Win:8.0
<task action> as show message task action	<show message task action>	Casts the specified task action as a message display action.	Win:8.0
id of <task action>	<string> Plural: ids	Returns the user-defined identifier for the specified action.	Win:8.0
type of <task action>	<task action type> Plural: types	Returns the type of the specified task action. This is one of the following types:com handler: start a custom COM handler.email: send an email.exec: perform a command-line operation such as running a script, launching an executable, or, if the name of.	Win:8.0

task action type

The <task action type> Inspectors return the Action Type(s) for a Windows Task. Action Types include Executables, Email messages, Handlers and Messages. For more information, see Task Actions at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
com handler task action type	Returns a 'task action type' corresponding to a task that activates a COM handler. Example: (it as Com Handler Task Action) of Actions whose (Type of it = Com Handler Task Action Type) of Definition of Scheduled Task "Test" - Returns a list of any 'com handler' actions in the scheduled task named 'Test'.	Win:8.0
email task action type	Returns a 'task action type' corresponding to a task that sends an email.	Win:8.0
exec task action type	Returns a 'task action type' corresponding to a task that runs a program.	Win:8.0
show message task action type	Returns a 'task action type' corresponding to a task that creates a message that will pop up on the desktop.	Win:8.0
task action type <integer>	Returns the task action type according to its enumerated value:0: TASK_ACTION_EXEC5: TASK_ACTION_COM_HANDLER6: TASK_ACTION_SEND_EMAIL7: TASK_ACTION_SHOW_MESSAGE.	Win:8.0
type of <task action>	Returns the type of the specified task action. This is one of the following types:com handler: start a custom COM handler.email: send an email.exec: perform a command-line operation such as running a script, launching an executable, or, if the name of.	Win:8.0

Operators

Declaration	Return Type	Description	Platforms (?)
<task action type> = <task action type>	<boolean>	Returns TRUE if the two task action types are equal.	Win:8.0

Properties

Declaration

Return type

Description

Platforms (?)

email task action

The <email task action> Inspectors deal with Windows Email Actions, which are specified by tasks triggered by various events like computer state changes or scheduled times. The Email Action causes an email to be sent. For more information, see Email Action at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task action> as email task action	Casts the specified task action as an email action.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
attachment of <email task action>	<string> Plural: attachments	Returns the array of attachments (as strings) to be sent with the email referenced by the specified email task action.	Win:8.0
bcc of <email task action>	<string> Plural: bccs	Returns the email address(es) that you want to Bcc in the email referenced by the specified email task action.	Win:8.0
body of <email task action>	<string> Plural: bodies	Returns the body of the email message referenced by the specified email task action.	Win:8.0
cc of <email task action>	<string> Plural: ccs	Returns the email address(es) that you want to Bcc in the email referenced by the specified email task action.	Win:8.0
from of <email task action>	<string> Plural: froms	Returns the 'from' email address for the email referenced by the specified email task action.	Win:8.0
header field of <email task action>	<task named value pair> Plural: header fields	Returns the header information (as named value pairs) from the email triggered by a scheduled task.	Win:8.0
replyto of <email task action>	<string> Plural: replytos	Returns the email reply address(es) for the email referenced by the specified email task action.	Win:8.0
server of <email task action>	<string> Plural: servers	Returns the name of the server used to send the email referenced by the specified email task action.	Win:8.0
subject of <email task action>	<string> Plural: subjects	Returns the subject line for the email referenced by the specified email task action.	Win:8.0
to of <email task action>	<string> Plural: tos	Returns the address(es) for the 'to' line of the email referenced by the specified email task action.	Win:8.0

exec task action

The <exec task action> Inspectors deal with Windows Exec Actions, which are specified by tasks triggered by various events like computer state changes or scheduled times. The Exec Action causes a program to run. For more information, see Exec Action at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task action> as exec task action	Casts the specified task action as an executable action.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
argument string of <exec task action>	<string> Plural: argument strings	Returns the arguments associated with the command-line operation referenced by the exec task action.	Win:8.0
path of <exec task action>	<string> Plural: paths	Returns the path to the executable file specified in the task action.	Win:8.0
working directory of <exec task action>	<string> Plural: working directories	Returns the the directory containing either the executable file or files used by the executable specified in the task action.	Win:8.0

com handler task action

The <com handler task action> Inspectors deal with Windows COM Handler Actions, which are specified by tasks triggered by various events like computer state changes or scheduled times. The COM Handler Action causes a handler to be fired. For more information, see COM Handler Action at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task action> as com handler task action	Casts the specified task action as a com handler task action.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
class id of <com handler task action>	<string> Plural: class ids	Returns a string containing the class ID of the specified 'com handler task action', corresponding to a task that activates a COM handler.	Win:8.0
data of <com handler task action>	<string> Plural: datas	Returns a string containing the data of the specified 'com handler task action', corresponding to a task that activates a COM handler.	Win:8.0

show message task action

The <show message task action> Inspectors deal with Windows Show Message Actions, which are specified by tasks triggered by various events like computer state changes or scheduled times. The Show Message Action causes a a message box to be displayed. For more information, see Show Message Action at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task action> as show message task action	Casts the specified task action as a message display action.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
message body of <show message task action>	<string> Plural: message bodies	Returns the message text (as a string) associated with the specified task action. This is the text displayed in the message box.	Win:8.0
title of <show message task action>	<string> Plural: titles	Returns the title text (as a string) associated with the specified task action. This is the title displayed at the top of the message box.	Win:8.0

task idle settings

The <task idle settings> objects specify how the Task Scheduler performs tasks when the computer is in an idle condition. These settings concern the duration, restart, stop and wait conditions for the specified idle settings. For more information about idle conditions, see 'Task Idle Conditions' at MSDN.

Creation Methods

Declaration	Description	Platforms (?)
idle setting of <task settings>	Returns the Idle Settings of the specified task. These can include:Idle durationRestart On IdleStop On Idle EndWait Timeout.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
idle duration of <task idle settings>	<time interval> Plural: idle durations	Returns a value that indicates the amount of time that the computer must be in an idle state before the task is run.	Win:8.0
restart on idle of <task idle settings>	<boolean> Plural: restart on idles	Returns a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more than once.	Win:8.0
stop on idle end of <task idle settings>	<boolean> Plural: stop on idle ends	Returns a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before the task is completed.	Win:8.0
wait timeout of <task idle settings>	<time interval> Plural: wait timeouts	Returns a time interval that represents the amount of time that the Task Scheduler will wait for an idle condition to occur.	Win:8.0

task network settings

The <task network settings> Inspectors provide the settings used by the Task Scheduler to obtain a network profile. A network settings object has an ID and a name.

Creation Methods

Declaration	Description	Platforms (?)
network setting of <task settings>	Returns a task network settings object containing a network profile ID and name. If this setting exists and the 'run only when network available' property is TRUE, the task will wait to execute until the specified network profile is available.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
id of <task network settings>	<string> Plural: ids	Returns a GUID that identifies a network profile.	Win:8.0
name of <task network settings>	<string> Plural: names	Returns the name of a network profile. The name is used for display purposes.	Win:8.0

task trigger

Task triggers for the Task Scheduler have properties that identify and modify the action of each trigger.

Creation Methods

Declaration	Description	Platforms (?)
trigger of <task definition>	Returns the triggers associated with the specified task definition.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
<task trigger> as boot task trigger	<boot task trigger>	Casts the given task trigger as a boot trigger type.	Win:8.0
<task trigger> as daily task trigger	<daily task trigger>	Casts the given task trigger as a daily trigger type.	Win:8.0
<task trigger> as event task trigger	<event task trigger>	Casts the given task trigger as an event trigger type.	Win:8.0
<task trigger> as idle task trigger	<idle task trigger>	Casts the given task trigger as an idle trigger type.	Win:8.0
<task trigger> as logon task trigger	<logon task trigger>	Casts the given task trigger as a logon trigger type.	Win:8.0
<task trigger> as monthly task trigger	<monthly task trigger>	Casts the given task trigger as a monthly trigger type.	Win:8.0
<task trigger> as monthlydow task trigger	<monthlydow task trigger>	Casts the given task trigger as a monthly DOW trigger type.	Win:8.0
<task trigger> as registration task trigger	<registration task trigger>	Casts the given task trigger as a registration trigger type.	Win:8.0
<task trigger> as session state change task trigger	<session state change task trigger>	Casts the given task trigger as a session trigger type.	Win:8.0
<task trigger> as time task trigger	<time task trigger>	Casts the given task trigger as a time trigger type.	Win:8.0
<task trigger> as weekly task trigger	<weekly task trigger>	Casts the given task trigger as a weekly trigger type.	Win:8.0
enabled of <task trigger>	<boolean> Plural: enableds	Returns TRUE if the specified trigger is enabled.	Win:8.0
end boundary of <task trigger>	<time> Plural: end boundaries	Returns a time corresponding to when the specified trigger is deactivated, after which it will no longer run.	Win:8.0
execution time limit of <task trigger>	<time interval> Plural: execution time limits	Returns a time interval corresponding to the maximum time allotted to the task.	Win:8.0
id of <task trigger>	<string> Plural: ids	Returns the identifier for the trigger (as a string).	Win:8.0
repetition of <task trigger>	<task repetition pattern> Plural: repetitions	Returns a task repetition pattern corresponding to how often the task will run and how long the repetition pattern will be repeated after the task has been started.	Win:8.0
start boundary of <task trigger>	<time> Plural: start boundaries	Returns the date and time when the trigger is activated, after which the task is launched.	Win:8.0
type of <task trigger>	<task trigger type> Plural: types	Returns the task trigger type corresponding to the specified task trigger.	Win:8.0

task trigger type

The <task trigger type> objects represent the possible types of triggers used by the Task Scheduler to fire off a task. Tasks can be triggered by dates, user actions and system events.

Creation Methods

Declaration	Description	Platforms (?)
boot task trigger type	Creates a task trigger type corresponding to a boot trigger, which starts a task when the system is booted up.	Win:8.0
daily task trigger type	Creates a task trigger type corresponding to a daily trigger, which starts a task on a daily schedule.	Win:8.0
event task trigger type	Creates a task trigger type corresponding to an event trigger, which starts a task when a system event occurs.	Win:8.0
idle task trigger type	Creates a task trigger type corresponding to a idle trigger, which starts a task when the system is enters the idle state.	Win:8.0
logon task trigger type	Creates a task trigger type corresponding to a logon trigger, which starts a task when a user logs on. When the scheduler starts, all the logged-on users are noted, and any logon triggers that match the users will launch their associated task.	Win:8.0
monthly task trigger type	Creates a task trigger type corresponding to a Monthly trigger, which starts a task when the associated day of the week occurs, such as the third of each month from July through December.	Win:8.0
monthlydow task trigger type	Creates a task trigger type corresponding to a MonthlyDOW trigger, which starts a task when the associated day of the week occurs, such as the second Monday from January through June.	Win:8.0
registration task trigger type	Creates a task trigger type corresponding to a registration trigger, which starts a task whenever it gets registered or updated.	Win:8.0
session state change task trigger type	Creates a task trigger type corresponding to a session state change trigger, which starts a task on console connects or disconnects, remote connects or disconnects, or workstation lock or unlock notifications.	Win:8.0
task trigger type <integer>	Creates a task trigger type corresponding to the given integer.	Win:8.0
time task trigger type	Creates a task trigger type corresponding to a time trigger, which starts a task on a specific date and time.	Win:8.0
weekly task trigger type	Creates a task trigger type corresponding to a weekly trigger, which starts a task on a weekly schedule, such as 9:00 AM each Wednesday.	Win:8.0
type of <task trigger>	Returns the task trigger type corresponding to the specified task trigger.	Win:8.0

Operators

Declaration	Return Type	Description	Platforms (?)
<task trigger type> = <task trigger type>	<boolean>	Returns TRUE if the two task trigger types are equal.	Win:8.0

Properties

Declaration

Return type

Description

Platforms (?)

time task trigger

Time triggers are used by the Task Scheduler to launch a task at a specific date and time.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as time task trigger	Casts the given task trigger as a time trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
random delay of <time task trigger>	<time interval> Plural: random delays	Returns a delay time that is randomly added to the start time of the specified time task trigger.	Win:8.0

weekly task trigger

Weekly triggers are used by the Task Scheduler to launch a task at a specific time of day on a weekly schedule, such as 9:00 PM every other Friday.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as weekly task trigger	Casts the given task trigger as a weekly trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
days run of <weekly task trigger>	<day of week> Plural: days runs	Returns a day of week corresponding to the days that a task will run given the specified weekly task trigger.	Win:8.0
random delay of <weekly task trigger>	<time interval> Plural: random delays	Returns a delay time that is randomly added to the start time of the specified weekly task trigger.	Win:8.0
weeks interval of <weekly task trigger>	<time interval> Plural: weeks intervals	Returns the interval between the weeks in the schedule provided by the specified weekly task trigger.	Win:8.0

daily task trigger

The <daily task trigger> Inspectors deal with tasks that are triggered on a daily basis. For example, a task might start at 9:00 AM every day or every other day. More information about this subset of task triggers can be found by searching for Daily Trigger at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as daily task trigger	Casts the given task trigger as a daily trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
days interval of <daily task trigger>	<time interval> Plural: days intervals	Returns the interval between the days in the schedule referred to by the specified daily task trigger.	Win:8.0
random delay of <daily task trigger>	<time interval> Plural: random delays	Returns a random time interval to be added to the start time of the trigger referred to by the specified daily task trigger.	Win:8.0

monthly task trigger

The <monthly task trigger> Inspectors deal with tasks that are triggered on a monthly basis. For example, a task might start at 9:00 AM on specific days of specific months. More information about this subset of task triggers can be found by searching for Monthly Trigger at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as monthly task trigger	Casts the given task trigger as a monthly trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
days run of <monthly task trigger>	<day of month> Plural: days runs	Returns the days of the month during which the task will run.	Win:8.0
months run of <monthly task trigger>	<month> Plural: months runs	Returns the months of the year during which the task will run.	Win:8.0
random delay of <monthly task trigger>	<time interval> Plural: random delays	Returns the upper limit of a random time delay that will be added to the trigger start time. The format is P<days>DT<hours>H<minutes>M<seconds>S. For example, P3DT6H represents a 3 day, 6 hour maximum, and the random time will be less than or equal to that value.	Win:8.0
run on last day in month of <monthly task trigger>	<boolean> Plural: run on last day in months	Returns TRUE if the specified monthly trigger is set to run on the last day of the month.	Win:8.0

monthlydow task trigger

The <monthlydow task trigger> Inspectors deal with tasks that are triggered on a repeating day-of-the-week basis. For example, the task might start at 9:00 AM on specific days of the week, weeks of the month, or months of the year. More information about this subset of task triggers can be found by searching for MonthlyDOW Trigger at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as monthlydow task trigger	Casts the given task trigger as a monthly DOW trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
days run of <monthlydow task trigger>	<day of week> Plural: days runs	Returns the days of the month during which the monthly day-of-week task will run.	Win:8.0
months run of <monthlydow task trigger>	<month> Plural: months runs	Returns the months of the year during which the monthly day-of-week task will run.	Win:8.0
random delay of <monthlydow task trigger>	<time interval> Plural: random delays	Returns the upper limit of a random time delay that will be added to the monthly day-of-week trigger start time. The format is P<days>DT<hours>H<minutes>M<seconds>S. For example, P3DT6H represents a 3 day, 6 hour maximum, and the random time will be less than or equal to that value.	Win:8.0
run on fifth week in month of <monthlydow task trigger>	<boolean> Plural: run on fifth week in months	Returns TRUE if the monthly day-of-week trigger will run the task in the fifth week of the month.	Win:8.0
run on first week in month of <monthlydow task trigger>	<boolean> Plural: run on first week in months	Returns TRUE if the monthly day-of-week trigger will run the task in the first week of the month.	Win:8.0
run on fourth week in month of <monthlydow task trigger>	<boolean> Plural: run on fourth week in months	Returns TRUE if the monthly day-of-week trigger will run the task in the fourth week of the month.	Win:8.0
run on last week in month of <monthlydow task trigger>	<boolean> Plural: run on last week in months	Returns TRUE if the monthly day-of-week trigger will run the task in the last week of the month.	Win:8.0
run on second week in month of <monthlydow task trigger>	<boolean> Plural: run on second week in months	Returns TRUE if the monthly day-of-week trigger will run the task in the second week of the month.	Win:8.0
run on third week in month of <monthlydow task trigger>	<boolean> Plural: run on third week in months	Returns TRUE if the monthly day-of-week trigger will run the task in the third week of the month.	Win:8.0

session state change task trigger

The <session state change task trigger> Inspectors return information about Windows actions that are triggered by changes in Terminal Server session states, such as switching users or logging in remotely.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as session state change task trigger	Casts the given task trigger as a session trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
console connect of <session state change task trigger>	<boolean> Plural: console connects	Returns a boolean TRUE if the terminal server console has experienced a connection state change, for instance when users are switched on the client computer.	Win:8.0
console disconnect of <session state change task trigger>	<boolean> Plural: console disconnects	Returns a boolean TRUE if the terminal server console has experienced a disconnect state change, for instance when users are switched on the client computer.	Win:8.0
delay of <session state change task trigger>	<time interval> Plural: delays	Returns a time interval corresponding to the delay between the detection of the specified session state change and the time the task is started.	Win:8.0
remote connect of <session state change task trigger>	<boolean> Plural: remote connects	Returns a boolean TRUE if the terminal server console has experienced a remote connection change, for instance when a user connects to a session using a remote desktop connection.	Win:8.0
remote disconnect of <session state change task trigger>	<boolean> Plural: remote disconnects	Returns a boolean TRUE if the terminal server console has experienced a remote disconnect change, for instance when a user disconnects from a session using a remote desktop connection.	Win:8.0
session lock of <session state change task trigger>	<boolean> Plural: session locks	Returns a boolean TRUE if the terminal server console has experienced a session lock change, for instance when a computer is locked.	Win:8.0
session unlock of <session state change task trigger>	<boolean> Plural: session unlocks	Returns a boolean TRUE if the terminal server console has experienced a session unlock change, for instance when a computer is unlocked.	Win:8.0
user id of <session state change task trigger>	<string> Plural: user ids	Returns the user identifier (as a string) required to run the tasks associated with the specified session state-change trigger.	Win:8.0

registration task trigger

The <registration task trigger> Inspectors deal with tasks that are triggered whenever the task is registered or updated. More information about this subset of task triggers can be found by searching for Registration triggers at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as registration task trigger	Casts the given task trigger as a registration trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
delay of <registration task trigger>	<time interval> Plural: delays	This Inspector returns the amount of time between when the task is registered and when the task is started. .	Win:8.0

event task trigger

The <event task trigger> Inspectors deal with tasks that are triggered by a specific event, such as a system start, logon or idle. More information about event task triggers can be found by searching for Task Triggers at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as event task trigger	Casts the given task trigger as an event trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
delay of <event task trigger>	<time interval> Plural: delays	Returns a value indicating the amount of time lapsed between the event trigger and the start of the task.	Win:8.0
subscription of <event task trigger>	<string> Plural: subscriptions	Returns the XPath query string identifying the trigger event.	Win:8.0
value query of <event task trigger>	<task named value pair> Plural: value queries	Returns a list of named XPath queries as name-value pairs. Each query in the list is applied to the last matching event XML returned from the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of a ShowMessage action.	Win:8.0

logon task trigger

The <logon task trigger> Inspectors deal with tasks that are triggered when a user logs on to the computer. More information about this subset of task triggers can be found by searching for Logon Trigger at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as logon task trigger	Casts the given task trigger as a logon trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
delay of <logon task trigger>	<time interval> Plural: delays	A task that is scheduled to run when the user is logged on can be delayed by 30 seconds or as long as a day. This Inspector returns the delay for the specified logon task trigger as a time interval.	Win:8.0
user id of <logon task trigger>	<string> Plural: user ids	Returns the user identifier (as a string) required to run the tasks associated with the specified logon trigger.	Win:8.0

boot task trigger

The <boot task trigger> Inspectors deal with tasks that are triggered when the system is booted up. More information about this subset of task triggers can be found by searching for Boot Trigger at the MSDN site.

Creation Methods

Declaration	Description	Platforms (?)
<task trigger> as boot task trigger	Casts the given task trigger as a boot trigger type.	Win:8.0

Properties

Declaration	Return type	Description	Platforms (?)
delay of <boot task trigger>	<time interval> Plural: delays	Returns a delay time interval to add to the start time of the trigger referred to by the specified boot task trigger.	Win:8.0

Terminology

Platform

Contents

Task Objects

task definition

Creation Methods

Properties

task settings

Creation Methods

Properties

priority class

Creation Methods

Operators

Properties

running task

Creation Methods

Properties

task named value pair

Creation Methods

Properties

scheduled task

Creation Methods

Properties

task folder

Creation Methods

Properties

task principal

Creation Methods

Properties

task registration info

Creation Methods

Properties

task repetition pattern

Creation Methods

Properties

task action

Creation Methods

Properties

task action type

Creation Methods

Operators

Properties

email task action

Creation Methods

Properties

exec task action

Creation Methods

Properties

com handler task action

Creation Methods

Properties

show message task action

Creation Methods

Properties

task idle settings

Creation Methods

Properties

task network settings

Creation Methods

Properties

task trigger

Creation Methods

Properties

task trigger type

Creation Methods

Operators

Properties

time task trigger

Creation Methods

Properties

weekly task trigger

Creation Methods

Properties

daily task trigger

Creation Methods

Properties

monthly task trigger

Creation Methods

Properties

monthlydow task trigger