TaskScheduler - Revision history

Water: /* Error and Success Constants */

2024-09-25T17:44:12Z

Error and Success Constants

← Older revision		Revision as of 17:44, 25 September 2024
Line 203:		Line 203:

	= Error and Success Constants =		= Error and Success Constants =
	When an error occurs, the Task Scheduler APIs ~~returns~~ one of the following [https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-error-and-success-constants error codes] as an HRESULT value.		When an error occurs, the Task Scheduler APIs return one of the following [https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-error-and-success-constants error codes] as an HRESULT value.

	= Functions =		= Functions =

Water: Fixed: Links used the german locale de-de. Changed to en-us.

2024-08-20T21:09:21Z

Fixed: Links used the german locale de-de. Changed to en-us.

← Older revision		Revision as of 21:09, 20 August 2024
Line 2:		Line 2:

	= Structure =		= Structure =
	The UDF uses the [https://docs.microsoft.com/de-de/windows/win32/taskschd/task-scheduler-objects Windows Task Scheduler Object Model]		The UDF uses the [https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-objects Windows Task Scheduler Object Model]

	[[File:Task Scheduler Object Model.png\|800px\|Task Scheduler Object Model]]		[[File:Task Scheduler Object Model.png\|800px\|Task Scheduler Object Model]]
Line 11:		Line 11:
	! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection		! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection !! Object/Collection
	\|-		\|-
	\| [https://docs.microsoft.com/de-de/windows/win32/taskschd/action Action]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/actioncollection Actions]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/idlesettings IdleSettings]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/networksettings NetworkSettings]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/principal Principal]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/registeredtask RegisteredTask]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/registeredtaskcollection RegisteredTasks]		\| [https://docs.microsoft.com/en-us/windows/win32/taskschd/action Action]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/actioncollection Actions]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/idlesettings IdleSettings]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/networksettings NetworkSettings]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/principal Principal]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/registeredtask RegisteredTask]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/registeredtaskcollection RegisteredTasks]
	\|-		\|-
	\| [https://docs.microsoft.com/de-de/windows/win32/taskschd/registrationinfo RegistrationInfo]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/repetitionpattern RepetitionPattern]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/runningtask RunningTask]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/runningtaskcollection RunningTasks]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/settings Settings]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/taskdefinition TaskDefinition]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/taskfolder Folder]		\| [https://docs.microsoft.com/en-us/windows/win32/taskschd/registrationinfo RegistrationInfo]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/repetitionpattern RepetitionPattern]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/runningtask RunningTask]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/runningtaskcollection RunningTasks]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/settings Settings]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/taskdefinition TaskDefinition]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/taskfolder Folder]
	\|-		\|-
	\| [https://docs.microsoft.com/de-de/windows/win32/taskschd/taskfoldercollection Folders]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/tasknamedvaluecollection NamedValues]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/tasknamedvaluepair NamedValuePair]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/taskservice TaskService]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/trigger Trigger]\|\|[https://docs.microsoft.com/de-de/windows/win32/taskschd/triggercollection Triggers]		\| [https://docs.microsoft.com/en-us/windows/win32/taskschd/taskfoldercollection Folders]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/tasknamedvaluecollection NamedValues]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/tasknamedvaluepair NamedValuePair]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/taskservice TaskService]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/trigger Trigger]\|\|[https://docs.microsoft.com/en-us/windows/win32/taskschd/triggercollection Triggers]
	\|}		\|}

Line 203:		Line 203:

	= Error and Success Constants =		= Error and Success Constants =
	When an error occurs, the Task Scheduler APIs returns one of the following [https://docs.microsoft.com/de-de/windows/win32/taskschd/task-scheduler-error-and-success-constants error codes] as an HRESULT value.		When an error occurs, the Task Scheduler APIs returns one of the following [https://docs.microsoft.com/en-us/windows/win32/taskschd/task-scheduler-error-and-success-constants error codes] as an HRESULT value.

	= Functions =		= Functions =

Water: /* _TS_Open */

2020-12-22T23:19:07Z

_TS_Open

← Older revision		Revision as of 23:19, 22 December 2020
Line 207:		Line 207:
	= Functions =		= Functions =
	== _TS_Open ==		== _TS_Open ==
	Connects to the Task Scheduler Service ~~and additionally~~ allows to control and manipulate the Task Scheduler on another computer.<br><br>		Connects to the Task Scheduler Service of the local computer or allows to control and manipulate the Task Scheduler on another computer.<br><br>

	~~You~~ must ensure the following before you begin (more details can be found [http://www.sarayoo.info/how-to-create-or-manage-scheduled-tasks-on-a-remote-computer-in-windows/ here]):		When connecting to another computer you must ensure the following before you begin (more details can be found [http://www.sarayoo.info/how-to-create-or-manage-scheduled-tasks-on-a-remote-computer-in-windows/ here]):

	* Your computer and the remote computer must be part of a domain or a Workgroup		* Your computer and the remote computer must be part of a domain or a Workgroup
Line 215:		Line 215:
	* You must have the login credentials for the remote computer and the login credential must be part of the Administrators group on the remote computer		* You must have the login credentials for the remote computer and the login credential must be part of the Administrators group on the remote computer
	* You may want to ensure that your Firewall allows “Remote Scheduled Tasks Management”		* You may want to ensure that your Firewall allows “Remote Scheduled Tasks Management”


	Examples how to connect to another computer (thanks to AdamUL for testing):		Examples how to connect to another computer (thanks to AdamUL for testing):
Line 236:		Line 235:
	</syntaxhighlight>		</syntaxhighlight>

	~~===~~ Debugging connection problems ~~===~~		'''Debugging connection problems'''<br>
	At the bottom of this github page you will find a tool named "[https://github.com/dahall/TaskSchedulerConfig Task Scheduler Configuration Troubleshooter]". It analyzes possible connection problems and tells you what to do or even tries to solve the problem.		At the bottom of this github page you will find a tool named "[https://github.com/dahall/TaskSchedulerConfig Task Scheduler Configuration Troubleshooter]". It analyzes possible connection problems and tells you what to do or even tries to solve the problem.

Water: Undo revision 14457 by Water (talk)

2020-12-22T23:16:06Z

Undo revision 14457 by Water (talk)

← Older revision		Revision as of 23:16, 22 December 2020
Line 236:		Line 236:
	</syntaxhighlight>		</syntaxhighlight>

	=== Debugging ~~===~~		=== Debugging connection problems ===
	~~==== Connection~~ problems ====
	At the bottom of this github page you will find a tool named "[https://github.com/dahall/TaskSchedulerConfig Task Scheduler Configuration Troubleshooter]". It analyzes possible connection problems and tells you what to do or even tries to solve the problem.		At the bottom of this github page you will find a tool named "[https://github.com/dahall/TaskSchedulerConfig Task Scheduler Configuration Troubleshooter]". It analyzes possible connection problems and tells you what to do or even tries to solve the problem.

Water: /* Debugging connection problems */

2020-12-22T23:14:09Z

Debugging connection problems

← Older revision		Revision as of 23:14, 22 December 2020
Line 236:		Line 236:
	</syntaxhighlight>		</syntaxhighlight>

	=== Debugging ~~connection~~ problems ===		=== Debugging ===
			==== Connection problems ====
	At the bottom of this github page you will find a tool named "[https://github.com/dahall/TaskSchedulerConfig Task Scheduler Configuration Troubleshooter]". It analyzes possible connection problems and tells you what to do or even tries to solve the problem.		At the bottom of this github page you will find a tool named "[https://github.com/dahall/TaskSchedulerConfig Task Scheduler Configuration Troubleshooter]". It analyzes possible connection problems and tells you what to do or even tries to solve the problem.

Water: /* Create task using _TS_TaskExportXML/_TS_TaskImportXML */

2020-02-07T10:20:05Z

Create task using _TS_TaskExportXML/_TS_TaskImportXML

← Older revision		Revision as of 10:20, 7 February 2020
Line 77:		Line 77:

	== Create task using _TS_TaskExportXML/_TS_TaskImportXML ==		== Create task using _TS_TaskExportXML/_TS_TaskImportXML ==
	Please have a look at the _TS_TaskCopy function in the UDF. This function shows how to create a new task using both XML inport/export functions.		Please have a look at the _TS_TaskCopy function in the UDF. This function shows how to create a new task using both XML inport/export functions.<br>
			The XML export does not contain the password if the LogonType is set to $TASK_LOGON_PASSWORD or any other logon type that requires a password. The password must be supplied at registration time.

	Example (for better readability all error checking has been removed):		Example (for better readability all error checking has been removed):

Water at 10:18, 7 February 2020

2020-02-07T10:18:09Z

← Older revision		Revision as of 10:18, 7 February 2020
Line 163:		Line 163:
	"PRINCIPAL\|ID\|Author", _		"PRINCIPAL\|ID\|Author", _
	"PRINCIPAL\|LogonType\|3", _		"PRINCIPAL\|LogonType\|3", _
	"PRINCIPAL\|UserId\|rt", _		"PRINCIPAL\|UserId\|xyz", _
	"REGISTRATIONINFO\|Author\|rt", _		"REGISTRATIONINFO\|Author\|xyz", _
	"REGISTRATIONINFO\|Date\|2019-10-02T13:39:03", _		"REGISTRATIONINFO\|Date\|2019-10-02T13:39:03", _
	"REGISTRATIONINFO\|Description\|Test-Description", _		"REGISTRATIONINFO\|Description\|Test-Description", _

Water: /* Functions */

2019-12-03T15:30:35Z

Functions

← Older revision		Revision as of 15:30, 3 December 2019
Line 245:		Line 245:

	== _TS_TaskRegister ==		== _TS_TaskRegister ==
	This function ~~finaly~~ creates the Task from a Task Definition object. ~~For~~ a ~~successful Task creation~~ you have to make sure that the Task Definition is free from errors ~~and that you register~~ the Task with the correct parameters.		This function finally creates or updates the Task from a Task Definition object.

			As a first step you have to make sure that the Task Definition is free from errors. Please have a look at _TS_TaskValidate to check the Task Definition for known errors.

			Then you need to call _TS_TaskRegister with the correct parameters.

	Here's a list of things we have learned while using the UDF:		Here's a list of things we have learned while using the UDF:
	* To register a task to run as an Admin you probably need to run the script that [https://www.autoitscript.com/forum/topic/200068-creating-a-brushed-up-task-scheduler-udf/?do=findComment&comment=1439129 creates the task] as an Admin.		* To register a task to run as an Admin you probably need to run the script that [https://www.autoitscript.com/forum/topic/200068-creating-a-brushed-up-task-scheduler-udf/?do=findComment&comment=1439129 creates the task] as an Admin.
Line 252:		Line 257:

	* When setting the logon type while creating the Principal sub-object of the Task Definition you have to set the logon type to $TASK_LOGON_NONE (or letting it default) to not overwrite the Principal setting.		* When setting the logon type while creating the Principal sub-object of the Task Definition you have to set the logon type to $TASK_LOGON_NONE (or letting it default) to not overwrite the Principal setting.

			== _TS_TaskUpdate ==
			After you have modified a Task you need to make the changes permanent by calling _TS_TaskUpdate or _TS_TaskRegister.

Water: /* _TS_TaskRegister */

2019-11-22T17:20:28Z

_TS_TaskRegister

← Older revision		Revision as of 17:20, 22 November 2019
Line 251:		Line 251:
	* A Task Definition created from XML (_TS_TaskImportXML or _TS_TaskCopy) does not contain the password used to create the source Task. Hence the password must be supplied by the registration function.		* A Task Definition created from XML (_TS_TaskImportXML or _TS_TaskCopy) does not contain the password used to create the source Task. Hence the password must be supplied by the registration function.

	* When setting the logon type while creating the Principal sub-object of the Task Definition you have to set the logon type to $TASK_LOGON_NONE (or letting it default) to not overwrite the ~~Prinicpal~~ setting.		* When setting the logon type while creating the Principal sub-object of the Task Definition you have to set the logon type to $TASK_LOGON_NONE (or letting it default) to not overwrite the Principal setting.

Water: /* _TS_TaskRegister */

2019-11-08T13:04:23Z

_TS_TaskRegister

← Older revision		Revision as of 13:04, 8 November 2019
Line 245:		Line 245:

	== _TS_TaskRegister ==		== _TS_TaskRegister ==
	To register a task to run as an Admin you probably need to run the script that [https://www.autoitscript.com/forum/topic/200068-creating-a-brushed-up-task-scheduler-udf/?do=findComment&comment=1439129 creates the task] as an Admin.		This function finaly creates the Task from a Task Definition object. For a successful Task creation you have to make sure that the Task Definition is free from errors and that you register the Task with the correct parameters.
			Here's a list of things we have learned while using the UDF:
			* To register a task to run as an Admin you probably need to run the script that [https://www.autoitscript.com/forum/topic/200068-creating-a-brushed-up-task-scheduler-udf/?do=findComment&comment=1439129 creates the task] as an Admin.

	A Task Definition created from XML does not contain the password if the ~~LogonType is set to $TASK_LOGON_PASSWORD or any other logon type that requires a password~~. ~~The~~ password must be supplied by the registration function.		* A Task Definition created from XML (_TS_TaskImportXML or _TS_TaskCopy) does not contain the password used to create the source Task. Hence the password must be supplied by the registration function.

			* When setting the logon type while creating the Principal sub-object of the Task Definition you have to set the logon type to $TASK_LOGON_NONE (or letting it default) to not overwrite the Prinicpal setting.

← Older revision		Revision as of 10:18, 7 February 2020
Line 163:		Line 163:
	"PRINCIPAL\|ID\|Author", _		"PRINCIPAL\|ID\|Author", _
	"PRINCIPAL\|LogonType\|3", _		"PRINCIPAL\|LogonType\|3", _
	"PRINCIPAL\|UserId\|rt", _		"PRINCIPAL\|UserId\|xyz", _
	"REGISTRATIONINFO\|Author\|rt", _		"REGISTRATIONINFO\|Author\|xyz", _
	"REGISTRATIONINFO\|Date\|2019-10-02T13:39:03", _		"REGISTRATIONINFO\|Date\|2019-10-02T13:39:03", _
	"REGISTRATIONINFO\|Description\|Test-Description", _		"REGISTRATIONINFO\|Description\|Test-Description", _