Scheduled Tasks - Revision history

Bugmenot: /* The Script */

2015-09-01T17:19:57Z

The Script: <highlight-nsis>

â† Older revision		Revision as of 17:19, 1 September 2015
Line 176:		Line 176:

	The following code can be added to the code above to delete a pre-existing task:		The following code can be added to the code above to delete a pre-existing task:
			<highlight-nsis>
	; ITaskScheduler->Delete()		; ITaskScheduler->Delete()
	System::Call '$R1->7(w r0) i.R9'		System::Call '$R1->7(w r0) i.R9'
			</highlight-nsis>
	It should be added before the line: ; ITaskScheduler->NewWorkItem()		It should be added before the line: <code>; ITaskScheduler->NewWorkItem()</code>

	=== Setting Task Flags ===		=== Setting Task Flags ===

	The following code can be added to schedule a task flag:		The following code can be added to schedule a task flag:
			<highlight-nsis>
	; ITask->SetFlags()		; ITask->SetFlags()
	System::Call '$R2->28(i 0x2000)'		System::Call '$R2->28(i 0x2000)'
			</highlight-nsis>
	Flags currently available:		Flags currently available:

Line 220:		Line 220:

	The following code can be added to the code above to disable the annoying "Stop the task if it runs for:" behavior. Windows' default is 72 hours. Per the API documentation, the value is in milliseconds, so you can use the below code snippet to change the 72 hours to something more to your liking. What you often care about is the INFINITE value, which disables the function altogether (note there are also other ways of doing this in this API). This value is tricky as some of the source code I read on the Internet claims that in Windows Vista and Windows 7, there is a bug where INFINITE doesn't work, and INFINITE-1 is needed to pass to the procedure. In any event, I've only tested this on Windows XP so your mileage may vary on those later operating systems:		The following code can be added to the code above to disable the annoying "Stop the task if it runs for:" behavior. Windows' default is 72 hours. Per the API documentation, the value is in milliseconds, so you can use the below code snippet to change the 72 hours to something more to your liking. What you often care about is the INFINITE value, which disables the function altogether (note there are also other ways of doing this in this API). This value is tricky as some of the source code I read on the Internet claims that in Windows Vista and Windows 7, there is a bug where INFINITE doesn't work, and INFINITE-1 is needed to pass to the procedure. In any event, I've only tested this on Windows XP so your mileage may vary on those later operating systems:
			<highlight-nsis>
	; ITask->SetMaxRunTime()		; ITask->SetMaxRunTime()
	; on Windows 7 and Vista this may have to be		; on Windows 7 and Vista this may have to be
	; 0xFFFFFFFF - 1 (whatever that is, not sure		; 0xFFFFFFFF - 1 (whatever that is, not sure
	; whether the hex is interpreted as signed		; whether the hex is interpreted as signed
	; or unsigned		; or unsigned
	System::Call '$R2->42(i 0xFFFFFFFF)'		System::Call '$R2->42(i 0xFFFFFFFF)'
			</highlight-nsis>
	It should be added somewhere in the section where ITask is being set up (I put it after ITask->SetParameters).		It should be added somewhere in the section where ITask is being set up (I put it after ITask->SetParameters).

Bugmenot: better wording

2015-06-15T14:38:24Z

better wording

â† Older revision		Revision as of 14:38, 15 June 2015
Line 1:		Line 1:
	Scheduling tasks is possible using the System plug-in. It involves creating COM objects, which is complicated in C++ and a black art in NSIS. brainsucker wrote the original version of this script and posted it to the forums. I've made some modifications.		Scheduling tasks is possible using the System plug-in. It involves creating COM objects, which is complicated in C++ and a black art in NSIS. brainsucker wrote the original version of this script and posted it to the forums. I've made some modifications.

	The first change is that he has the system plugin ~~remain~~ loaded during the entire script run. I opt for loading and unloading it in the plugin. If you call this in a function or section that uses the system plugin's private registers, push and pop them as they will be destroyed by this function.		The first change is that brainsucker's old version has the system plugin remaining loaded during the entire script run. I opt for loading and unloading it in the plugin. If you call this in a function or section that uses the system plugin's private registers, push and pop them as they will be destroyed by this function.

	The second change to this script is that it sets the user that ~~run~~ the task. If you want the user running the installer to be the user that executes the task just put bogus values in this field. I could make the function detect null values for user name and password, but I wanted to get this script up with the increased functionality of setting the user.		The second change to this script is that it sets the user that runs the task. If you want the user running the installer to be the user that executes the task just put bogus values in this field. I could make the function detect null values for user name and password, but I wanted to get this script up with the increased functionality of setting the user.

	= The Script =		= The Script =

Bugmenot: /* Links */ TASK_TRIGGER structure link

2014-01-24T12:04:22Z

Links: TASK_TRIGGER structure link

â† Older revision		Revision as of 12:04, 24 January 2014
Line 231:		Line 231:

	= Links =		= Links =
	[http://forums.winamp.com/showthread.php?s=&threadid=147686&highlight=scheduled+task This forum thread] contains the original version of this script.		*[http://forums.winamp.com/showthread.php?s=&threadid=147686&highlight=scheduled+task This forum thread] contains the original version of this script.
			*[http://msdn.microsoft.com/en-us/library/windows/desktop/aa383618%28v=vs.85%29.aspx This MSDN link] describes the TASK_TRIGGER structure used in this script

	[[Category:Tutorials]]		[[Category:Tutorials]]
	[[Category:System Plugin Examples]]		[[Category:System Plugin Examples]]
	[[Category:COM Programming]]		[[Category:COM Programming]]

PeterMortensen: Copy edited.

2013-05-06T20:23:46Z

Copy edited.

â† Older revision		Revision as of 20:23, 6 May 2013
Line 1:		Line 1:
	Scheduling tasks is possible using the System plug-in. It involves creating COM objects, which is complicated in C++ and a black art in NSIS. brainsucker wrote the original version of this script and posted it to the forums. I've made some modifications.		Scheduling tasks is possible using the System plug-in. It involves creating COM objects, which is complicated in C++ and a black art in NSIS. brainsucker wrote the original version of this script and posted it to the forums. I've made some modifications.

	The first is he has the system plugin remain loaded the entire script. I opt for loading and unloading it in the plugin. If you call this in a function or section that uses the system plugin's private registers push and pop them as they will be destroyed by this function.		The first change is that he has the system plugin remain loaded during the entire script run. I opt for loading and unloading it in the plugin. If you call this in a function or section that uses the system plugin's private registers, push and pop them as they will be destroyed by this function.

	The second change to this script is that it sets the user that run the task. If you want the user running the installer to be the user that executes the task just put bogus values in this field. I could make the function detect null values for user name and password, but I wanted to get this script up with the increased functionality of setting the user.		The second change to this script is that it sets the user that run the task. If you want the user running the installer to be the user that executes the task just put bogus values in this field. I could make the function detect null values for user name and password, but I wanted to get this script up with the increased functionality of setting the user.
Line 219:		Line 219:
	=== SetMaxRunTime() (stop the task killing itself after 72 hours) ===		=== SetMaxRunTime() (stop the task killing itself after 72 hours) ===

	The following code can be added to the code above to disable the annoying "Stop the task if it runs for:" behavior. Windows' default is 72 hours. Per the API documentation, the value is in milliseconds, so you can use the below code snippet to change the 72 hours to something more to your liking. What you often care about is the INFINITE value, which disables the function altogether (note there are also other ways of doing this in this API). This value is tricky as some of the source code I read on the Internet claims that in Vista and Windows 7, there is a bug where INFINITE doesn't work, and INFINITE-1 is needed to pass to the procedure. In any event, I've only tested this on XP so your mileage may vary on those later operating systems:		The following code can be added to the code above to disable the annoying "Stop the task if it runs for:" behavior. Windows' default is 72 hours. Per the API documentation, the value is in milliseconds, so you can use the below code snippet to change the 72 hours to something more to your liking. What you often care about is the INFINITE value, which disables the function altogether (note there are also other ways of doing this in this API). This value is tricky as some of the source code I read on the Internet claims that in Windows Vista and Windows 7, there is a bug where INFINITE doesn't work, and INFINITE-1 is needed to pass to the procedure. In any event, I've only tested this on Windows XP so your mileage may vary on those later operating systems:

	; ITask->SetMaxRunTime()		; ITask->SetMaxRunTime()
Line 228:		Line 228:
	System::Call '$R2->42(i 0xFFFFFFFF)'		System::Call '$R2->42(i 0xFFFFFFFF)'

	It should be added somewhere in the section where ITask is being set up (I put it after ITask->SetParameters)		It should be added somewhere in the section where ITask is being set up (I put it after ITask->SetParameters).

	= Links =		= Links =

38.111.136.111 at 17:08, 5 March 2012

2012-03-05T17:08:16Z

â† Older revision		Revision as of 17:08, 5 March 2012
Line 216:		Line 216:

	TASK_FLAG_RUN_ONLY_IF_LOGGED_ON (0x2000)		TASK_FLAG_RUN_ONLY_IF_LOGGED_ON (0x2000)

			=== SetMaxRunTime() (stop the task killing itself after 72 hours) ===

			The following code can be added to the code above to disable the annoying "Stop the task if it runs for:" behavior. Windows' default is 72 hours. Per the API documentation, the value is in milliseconds, so you can use the below code snippet to change the 72 hours to something more to your liking. What you often care about is the INFINITE value, which disables the function altogether (note there are also other ways of doing this in this API). This value is tricky as some of the source code I read on the Internet claims that in Vista and Windows 7, there is a bug where INFINITE doesn't work, and INFINITE-1 is needed to pass to the procedure. In any event, I've only tested this on XP so your mileage may vary on those later operating systems:

			; ITask->SetMaxRunTime()
			; on Windows 7 and Vista this may have to be
			; 0xFFFFFFFF - 1 (whatever that is, not sure
			; whether the hex is interpreted as signed
			; or unsigned
			System::Call '$R2->42(i 0xFFFFFFFF)'

			It should be added somewhere in the section where ITask is being set up (I put it after ITask->SetParameters)

	= Links =		= Links =

Kichik: Reverted edits by 109.230.244.146 to last version by 173.228.31.192

2011-12-16T22:58:08Z

Reverted edits by 109.230.244.146 to last version by 173.228.31.192

â† Older revision		Revision as of 22:58, 16 December 2011
Line 40:		Line 40:
	; 6 = At System Startup		; 6 = At System Startup
	; 7 = At Logon		; 7 = At Logon
	; these ~~[http://www.diamondlinks.net link building]~~ types use the following structure (so 7 means trigger at Logon):		; these types use the following structure (so 7 means trigger at Logon):
	; push "*(&l2, &i2 0, &i2 2003, &i2 9, &i2 4, &i2 0, &i2 0, &i2 0, &i2 14, &i2 20, i 0, i 0, i 0, i 7, i 0, &i2 0, i 0, &i2 0) i.s"		; push "*(&l2, &i2 0, &i2 2003, &i2 9, &i2 4, &i2 0, &i2 0, &i2 0, &i2 14, &i2 20, i 0, i 0, i 0, i 7, i 0, &i2 0, i 0, &i2 0) i.s"
	; 1 = DAILY - field 15 gives interval in days (here it 15)		; 1 = DAILY - field 15 gives interval in days (here it 15)

109.230.244.146 at 20:04, 16 December 2011

2011-12-16T20:04:09Z

â† Older revision		Revision as of 20:04, 16 December 2011
Line 40:		Line 40:
	; 6 = At System Startup		; 6 = At System Startup
	; 7 = At Logon		; 7 = At Logon
	; these types use the following structure (so 7 means trigger at Logon):		; these [http://www.diamondlinks.net link building] types use the following structure (so 7 means trigger at Logon):
	; push "*(&l2, &i2 0, &i2 2003, &i2 9, &i2 4, &i2 0, &i2 0, &i2 0, &i2 14, &i2 20, i 0, i 0, i 0, i 7, i 0, &i2 0, i 0, &i2 0) i.s"		; push "*(&l2, &i2 0, &i2 2003, &i2 9, &i2 4, &i2 0, &i2 0, &i2 0, &i2 14, &i2 20, i 0, i 0, i 0, i 7, i 0, &i2 0, i 0, &i2 0) i.s"
	; 1 = DAILY - field 15 gives interval in days (here it 15)		; 1 = DAILY - field 15 gives interval in days (here it 15)

173.228.31.192: Edited for grammar

2011-07-05T21:10:47Z

Edited for grammar

â† Older revision		Revision as of 21:10, 5 July 2011
Line 29:		Line 29:
	; 11, 12 - Duration and Interval of task in minutes. (duration - the whole		; 11, 12 - Duration and Interval of task in minutes. (duration - the whole
	; time task will work, interval - time between runs. D = 120,		; time task will work, interval - time between runs. D = 120,
	; I = 10: task will be ~~runned~~ every 10 minutes for 2 hours).		; I = 10: task will be run every 10 minutes for 2 hours).
	; 13 - flags (should be ored (\|)):		; 13 - flags (should be ored (\|)):
	; 1 - task has end date (6,7,8 defined)		; 1 - task has end date (6,7,8 defined)
Line 36:		Line 36:
	; 14 - trigger type: there are 7 different types, every one with it own		; 14 - trigger type: there are 7 different types, every one with it own
	; structure		; structure
	; 0 = ONCE task will be ~~runned~~ once		; 0 = ONCE task will be run once
	; 5 = On IDLE task will run on system IDLE (ITask->SetIdleWait)		; 5 = On IDLE task will run on system IDLE (ITask->SetIdleWait)
	; 6 = At System Startup		; 6 = At System Startup

80.156.46.53: /* The Script */

2008-12-03T13:26:30Z

The Script

â† Older revision		Revision as of 13:26, 3 December 2008
Line 162:		Line 162:
	i 1, \		i 1, \
	&i2 1, &i2 00, &i2 0, i 0, &i2 0) i.s"		&i2 1, &i2 00, &i2 0, i 0, &i2 0) i.s"
	push "~~ZippyBackup~~"		push "Username"
	push "~~ZippyPassword~~"		push "Userpassword"
	Call CreateTask		Call CreateTask
	Pop $0		Pop $0

70.96.32.114 at 18:26, 13 August 2008

2008-08-13T18:26:48Z

â† Older revision		Revision as of 18:26, 13 August 2008
Line 172:		Line 172:

	</highlight-nsis>		</highlight-nsis>

			=== Delete Task ===

			The following code can be added to the code above to delete a pre-existing task:

			; ITaskScheduler->Delete()
			System::Call '$R1->7(w r0) i.R9'

			It should be added before the line: ; ITaskScheduler->NewWorkItem()

	=== Setting Task Flags ===		=== Setting Task Flags ===