RegisteredTask.RunEx method

Article
12/11/2020

For scripting, runs the registered task immediately using specified flags and a session identifier.

Syntax

RegisteredTask.RunEx( _
  ByVal params, _
  ByVal flags, _
  ByVal sessionID, _
  ByRef runningTask _
)

Parameters

params [in]

The parameters used as values in the task actions. To not specify any parameter values for the task actions, set this parameter to Nothing. Otherwise, a single string value or an array of string values can be specified.

The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in the action properties.

If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties.

A maximum of 32 string values can be specified.

For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see Task Actions.

flags [in]

A TASK_RUN_FLAGS constant that defines how the task is run.

sessionID [in]

The terminal server session in which you want to launch the task.

If the TASK_RUN_USE_SESSION_ID constant (0x4) is not passed into the flags parameter, then the value specified in this parameter is ignored. If the TASK_RUN_USE_SESSION_ID constant is passed into the flags parameter and the sessionID value is less than or equal to 0, then an invalid argument error will be returned.

If the TASK_RUN_USE_SESSION_ID constant is passed into the flags parameter and the sessionID value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service will try to launch the task interactively as the user who is logged on to the specified session.

If the TASK_RUN_USE_SESSION_ID constant is passed into the flags parameter and the sessionID value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service will try to launch the task interactively as the user who is specified in the user parameter.

runningTask [out]

A RunningTask object that defines the new instance of the task.

Return value

This method does not return a value.

Remarks

This method will return without error, but the task will not run if the TaskSettings.AllowDemandStart property is set to false for the registered task.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Type library	Taskschd.tlb
DLL	Taskschd.dll