Core Function RunShellWait - Revision history

UberFoX: 1 revision

2015-06-14T12:37:04Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:50Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* show options */

2012-04-22T22:50:20Z

show options

← Older revision		Revision as of 22:50, 22 April 2012
Line 44:		Line 44:
	0 = Run within the current process so that anything printed to console by the run program appears directly on ours.		0 = Run within the current process so that anything printed to console by the run program appears directly on ours.
	1 = Run the program within its own window and dont share our console.		1 = Run the program within its own window and dont share our console.
−	~~2 = Same as 1 but return a string of the STDOUT and STDERROR (Stuff printed to the console).~~
	</pre>		</pre>

UberFoX: /* Example */

2012-04-22T22:50:10Z

Example

← Older revision		Revision as of 22:50, 22 April 2012
Line 64:		Line 64:

	=== Example ===		=== Example ===
−
−	~~<syntaxhighlight lang="sputnik">~~
−	~~$val = RunShellWait('Notepad.exe', 'C:\WINDOWS', @SW_SHOWNORMAL);~~
−	~~// script waits until Notepad closes~~
−	~~MsgBox("Program returned with exit code: $val");~~
−	~~</syntaxhighlight>~~
−
−	~~Example of using flag 2 to capture STDOUT (Stuff printed to console)~~

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">

UberFoX: /* Example */

2012-04-22T22:49:21Z

Example

← Older revision		Revision as of 22:49, 22 April 2012
Line 64:		Line 64:

	=== Example ===		=== Example ===
		+
		+	<syntaxhighlight lang="sputnik">
		+	$val = RunShellWait('Notepad.exe', 'C:\WINDOWS', @SW_SHOWNORMAL);
		+	// script waits until Notepad closes
		+	MsgBox("Program returned with exit code: $val");
		+	</syntaxhighlight>
		+
		+	Example of using flag 2 to capture STDOUT (Stuff printed to console)

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">

UberFoX: /* show options */

2012-04-22T22:45:49Z

show options

← Older revision		Revision as of 22:45, 22 April 2012
Line 44:		Line 44:
	0 = Run within the current process so that anything printed to console by the run program appears directly on ours.		0 = Run within the current process so that anything printed to console by the run program appears directly on ours.
	1 = Run the program within its own window and dont share our console.		1 = Run the program within its own window and dont share our console.
		+	2 = Same as 1 but return a string of the STDOUT and STDERROR (Stuff printed to the console).
	</pre>		</pre>

UberFoX: Created page with "

 RunShellWait( , , , , ,  )

=== Description === Runs an external program (Using ShellExecute) and waits until..."

2011-12-11T20:58:36Z

Created page with "<pre> RunShellWait( <file>, <timeout>, <arguments>, <workdir>, <flag>, <show options> ) </pre> === Description === Runs an external program (Using ShellExecute) and waits until..."

New page

<pre>
RunShellWait( <file>, <timeout>, <arguments>, <workdir>, <flag>, <show options> )
</pre>

=== Description ===

Runs an external program (Using ShellExecute) and waits until the program finishes.

=== Parameters ===

==== file ====

The name of the executable (EXE, BAT, COM, or PIF) to run.

==== timeout ====

Optional; Amount of seconds to wait for process to terminate.

Default -1 which means wait forever.

==== arguments ====

Optional; The arguments to use.

==== workdir ====

Optional; The working directory.

==== flag ====

Optional; The "show" flag of the executed program:
<pre>
@SW_HIDE = Hidden window
@SW_MINIMIZE = Minimized window
@SW_MAXIMIZE = Maximized window
</pre>

Default runs the program normally.

==== show options ====

Optional; Options how to executed program will run:
<pre>
0 = Run within the current process so that anything printed to console by the run program appears directly on ours.
1 = Run the program within its own window and dont share our console.
</pre>

Default 0.

=== Return Value ===

Success: The PID of the process that was launched.

Failure: 0.

=== Remarks ===

A benefit of using ShellExecute is more programs will work without an absolute path etc.

After running the requested program the script pauses until the program terminates. To run a program and then immediately continue script execution use the RunShell function instead.

Some programs will appear to return immediately even though they are still running; these programs spawn another process - you may be able to use the ProcessWaitClose function to handle these cases.

=== Example ===

<syntaxhighlight lang="sputnik">
$val = RunShellWait('Notepad.exe', 'C:\WINDOWS', @SW_SHOWNORMAL);
// script waits until Notepad closes
MsgBox("Program returned with exit code: $val");
</syntaxhighlight>

[[Category:Core Function]]