Talk:NSIS Service Lib - Revision history

Christifuzius: replaced

 with

2012-01-10T14:53:45Z

replaced <pre> with <highlight-nsis>

â† Older revision		Revision as of 14:53, 10 January 2012
Line 254:		Line 254:
	: Specifies the maximum time to wait (in seconds). It the timeout is reached before the service enters the desired state, "timeout" is returned in ''$0''		: Specifies the maximum time to wait (in seconds). It the timeout is reached before the service enters the desired state, "timeout" is returned in ''$0''

	<~~pre~~>		<highlight-nsis>
	lbl_waitfor:		lbl_waitfor:
	!insertmacro CALL_GETPARAM $7 "status" "n" "lbl_done" ; $7 is status as string		!insertmacro CALL_GETPARAM $7 "status" "n" "lbl_done" ; $7 is status as string
Line 284:		Line 284:
	Pop $R1		Pop $R1
	Goto lbl_good		Goto lbl_good
	</~~pre~~>		</highlight-nsis>

	I hope you find this useful, however it's up to you to add it to the 'official' library. I just wanted to contribute my work because your library has helped me a lot!		I hope you find this useful, however it's up to you to add it to the 'official' library. I just wanted to contribute my work because your library has helped me a lot!

	--[[User:Christifuzius\|Christifuzius]] 14:51, 10 January 2012 (UTC)		--[[User:Christifuzius\|Christifuzius]] 14:51, 10 January 2012 (UTC)

Christifuzius: /* Added function: waitfor */

2012-01-10T14:51:51Z

Added function: waitfor

â† Older revision		Revision as of 14:51, 10 January 2012
Line 287:		Line 287:

	I hope you find this useful, however it's up to you to add it to the 'official' library. I just wanted to contribute my work because your library has helped me a lot!		I hope you find this useful, however it's up to you to add it to the 'official' library. I just wanted to contribute my work because your library has helped me a lot!

			--[[User:Christifuzius\|Christifuzius]] 14:51, 10 January 2012 (UTC)

Christifuzius: added function waitfor

2012-01-10T14:50:38Z

added function waitfor

â† Older revision		Revision as of 14:50, 10 January 2012
Line 246:		Line 246:
	strcmp $R7 0 0 lbl_descriptioncomplete		strcmp $R7 0 0 lbl_descriptioncomplete
	Claus Henning ([[Special:Contributions/195.226.184.202\|195.226.184.202]]) 12:33, 6 January 2011 (UTC)		Claus Henning ([[Special:Contributions/195.226.184.202\|195.226.184.202]]) 12:33, 6 January 2011 (UTC)

			== Added function: waitfor ==
			I added a function to servicelib that waits for the service to reach a specific state. This function takes two parameters:
			; status
			: Can be ''running'', ''stopped'' or ''paused'' and specifies for which state the function should wait.
			; timeout
			: Specifies the maximum time to wait (in seconds). It the timeout is reached before the service enters the desired state, "timeout" is returned in ''$0''

			<pre>
			lbl_waitfor:
			!insertmacro CALL_GETPARAM $7 "status" "n" "lbl_done" ; $7 is status as string
			StrCpy $8 ${SERVICE_RUNNING} ; $8 is status as hex int
			StrCmp $7 "running" lbl_waitforstatus
			StrCpy $8 ${SERVICE_STOPPED}
			StrCmp $7 "stopped" lbl_waitforstatus
			StrCpy $8 ${SERVICE_PAUSED}
			StrCmp $7 "paused" lbl_waitforstatus
			StrCpy $0 "false" ; illegal parameter "status"
			Goto lbl_done
			lbl_waitforstatus:

			!insertmacro CALL_GETPARAM $9 "timeout" "30" "lbl_waitfortimeout" ; $9 is timeout in seconds
			lbl_waitfortimeout:

			Push $R1 ; SERVICE_STATUS structure
			StrCpy $0 "timeout" ; in case we reach timeout
			lbl_waitforloop:
			Sleep 1000
			System::Call '*(i,i,i,i,i,i,i) i.R1'
			System::Call 'advapi32::QueryServiceStatus(i r5, i $R1) i'
			System::Call '*$R1(i, i .r6)' ; $6 is now service status from QueryServiceStatus()
			System::Free $R1
			IntOp $9 $9 - 1
			StrCmp $9 0 lbl_done ; timeout reached
			IntFmt $6 "0x%X" $6
			IntCmp $6 $8 0 lbl_waitforloop lbl_waitforloop
			Pop $R1
			Goto lbl_good
			</pre>

			I hope you find this useful, however it's up to you to add it to the 'official' library. I just wanted to contribute my work because your library has helped me a lot!

195.226.184.202: /* Error in lbl_description */

2011-01-06T12:35:27Z

Error in lbl_description

â† Older revision		Revision as of 12:35, 6 January 2011
Line 245:		Line 245:
	after label lbl_description is incorrect. ChangeServiceConfig2 returns a boolean. Thus you have to change it to		after label lbl_description is incorrect. ChangeServiceConfig2 returns a boolean. Thus you have to change it to
	strcmp $R7 0 0 lbl_descriptioncomplete		strcmp $R7 0 0 lbl_descriptioncomplete
	[[Special:Contributions/195.226.184.202\|195.226.184.202]] 12:33, 6 January 2011 (UTC)		Claus Henning ([[Special:Contributions/195.226.184.202\|195.226.184.202]]) 12:33, 6 January 2011 (UTC)

195.226.184.202: /* Error in lbl_description */ new section

2011-01-06T12:33:42Z

Error in lbl_description: new section

â† Older revision		Revision as of 12:33, 6 January 2011
Line 238:		Line 238:

	----		----

			== Error in lbl_description ==

			The line
			strcmp $R7 "error" 0 lbl_descriptioncomplete
			after label lbl_description is incorrect. ChangeServiceConfig2 returns a boolean. Thus you have to change it to
			strcmp $R7 0 0 lbl_descriptioncomplete
			[[Special:Contributions/195.226.184.202\|195.226.184.202]] 12:33, 6 January 2011 (UTC)

Eneron52: /* Usage Examples */

2010-09-08T21:38:07Z

Usage Examples

â† Older revision		Revision as of 21:38, 8 September 2010
Line 188:		Line 188:
	The code currently uses the t text type and a forced A function suffix, these don't match in the unicode build! All it takes is to remove the A suffix probably (And test that the code still works)		The code currently uses the t text type and a forced A function suffix, these don't match in the unicode build! All it takes is to remove the A suffix probably (And test that the code still works)
	--[[User:Anders\|Anders]] 16:46, 5 August 2010 (UTC)		--[[User:Anders\|Anders]] 16:46, 5 August 2010 (UTC)

			----

	----		----
Line 219:		Line 221:
	CHANGE FROM:		CHANGE FROM:
	!insertmacro CALL_GETPARAM $R1 "depend" "n" "lbl_depend"		!insertmacro CALL_GETPARAM $R1 "depend" "n" "lbl_depend"
	TO:		TO:
	!insertmacro CALL_GETPARAM $R1 "depend" "n" "lbl_depend" "${UN}"		!insertmacro CALL_GETPARAM $R1 "depend" "n" "lbl_depend" "${UN}"

Line 233:		Line 235:

	!insertmacro SERVICE "delete" <Service Name> "" "un."		!insertmacro SERVICE "delete" <Service Name> "" "un."


			----

Eneron52: /* Usage Examples */

2010-09-08T21:36:45Z

Usage Examples

â† Older revision		Revision as of 21:36, 8 September 2010
Line 225:		Line 225:

	!insertmacro SERVICE "create" <Service Name> "<params>" ""		!insertmacro SERVICE "create" <Service Name> "<params>" ""

	!insertmacro SERVICE "start" <Service Name> "" ""		!insertmacro SERVICE "start" <Service Name> "" ""

Line 230:		Line 231:

	!insertmacro SERVICE "stop" <Service Name> "" "un."		!insertmacro SERVICE "stop" <Service Name> "" "un."

	!insertmacro SERVICE "delete" <Service Name> "" "un."		!insertmacro SERVICE "delete" <Service Name> "" "un."

Eneron52: /* Usage Examples */

2010-09-08T21:34:04Z

Usage Examples

â† Older revision		Revision as of 21:34, 8 September 2010
Line 188:		Line 188:
	The code currently uses the t text type and a forced A function suffix, these don't match in the unicode build! All it takes is to remove the A suffix probably (And test that the code still works)		The code currently uses the t text type and a forced A function suffix, these don't match in the unicode build! All it takes is to remove the A suffix probably (And test that the code still works)
	--[[User:Anders\|Anders]] 16:46, 5 August 2010 (UTC)		--[[User:Anders\|Anders]] 16:46, 5 August 2010 (UTC)

			----

			To whomever maintains this code.

			There is an easy way to get rid of the following define lines:

			!ifndef UN
			!define UN ""
			!endif

			1) Just add another parameter (UN) to the SERVICE macro (line just below the above)...

			CHANGE FROM:
			!macro SERVICE ACTION NAME PARAM
			TO:
			!macro SERVICE ACTION NAME PARAM UN

			This macro already uses the global value of the UN define; with the above change, it will use the local value.

			2) Similarly, change the CALL_GETPARAM macro by also adding the (UN) parameter

			CHANGE FROM:
			!macro CALL_GETPARAM VAR NAME DEFAULT LABEL
			TO:
			!macro CALL_GETPARAM VAR NAME DEFAULT LABEL UN

			3) Finally, change all the calls to the CALL_GETPARAM to add the (UN) parameter. In the code, all those calls are made from the FUNC_SERVICE macro and this one already has the (UN) parameter but doesn't make any use of it! There are 11 such calls in FUNC_SERVICE... So for example, change the following call:

			CHANGE FROM:
			!insertmacro CALL_GETPARAM $R1 "depend" "n" "lbl_depend"
			TO:
			!insertmacro CALL_GETPARAM $R1 "depend" "n" "lbl_depend" "${UN}"

			What those changes buy you is the ability to call this code from your installer either in regular install or in uninstall code (I believe the global DEFINE only lets you call this code in one of those context)! For example, you can create and start a service in your install code using the following line:

			!insertmacro SERVICE "create" <Service Name> "<params>" ""
			!insertmacro SERVICE "start" <Service Name> "" ""

			and you can stop and delete it in your uninstall code using the following line:

			!insertmacro SERVICE "stop" <Service Name> "" "un."
			!insertmacro SERVICE "delete" <Service Name> "" "un."

Anders at 16:46, 5 August 2010

2010-08-05T16:46:53Z

â† Older revision		Revision as of 16:46, 5 August 2010
Line 182:		Line 182:
	!insertmacro SERVICE create "${SERVICE_NAME}" "path=$INSTDIR\x-win32.exe;autostart=1;interact=0;display=${SERVICE_DISPLAYNAME};description=${SERVICE_DESCRIPTION};"		!insertmacro SERVICE create "${SERVICE_NAME}" "path=$INSTDIR\x-win32.exe;autostart=1;interact=0;display=${SERVICE_DISPLAYNAME};description=${SERVICE_DESCRIPTION};"
	</pre>		</pre>


			----

			The code currently uses the t text type and a forced A function suffix, these don't match in the unicode build! All it takes is to remove the A suffix probably (And test that the code still works)
			--[[User:Anders\|Anders]] 16:46, 5 August 2010 (UTC)

Rdk at 00:54, 20 February 2009

2009-02-20T00:54:58Z

â† Older revision		Revision as of 00:54, 20 February 2009
Line 170:		Line 170:
	StrCmp $6 0 lbl_done lbl_good		StrCmp $6 0 lbl_done lbl_good
	</highlight-nsis>		</highlight-nsis>

			= Usage Examples =

			* Stop a service whose name defined in macro
			<pre>
			!insertmacro SERVICE stop "${SERVICE_NAME}" ""
			</pre>

			* Create a service using macros for name; no newlines in the arguments
			<pre>
			!insertmacro SERVICE create "${SERVICE_NAME}" "path=$INSTDIR\x-win32.exe;autostart=1;interact=0;display=${SERVICE_DISPLAYNAME};description=${SERVICE_DESCRIPTION};"
			</pre>