Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Syntax
WinExec(strCommand{ | ,{ optNumState | 0 | 1 | 2 | 3 | 4 | 7 }{ | ,{ optNumSync | 0 | 1
},"optTagReturnOrHandle" } })
strCommand
optNumState
The command to be executed.
The initial state of the program (if any) that is run by the command:
Value
Description
optNumSync
0 Hides the program and gives control to another one.
1 Activates and displays the program.
2 Activates the program and displays it as an icon.
3 Activates the program and maximizes it.
4 Shows the program at its recent size. The program is still active.
7 Shows the program as an icon. The program is still active.
This is an optional parameter. If no value is specified, then the default value is 1.
Note: This parameter is not supported on Windows Embedded target systems;
regardless of what value is actually specified, the function is executed as if the
default value is specified.
A setting that specifies whether the command will execute synchronously or asynchronously:
Value
Description
0 Execute asynchronously; the function will return immediately.
1 Execute synchronously; the function will return when the command
has finished executing.
This is an optional parameter. If no value is specified, then the default value is 0.
optTagReturnOrHandle
Tip: To verify that a command executed asynchronously has finished, use the
optTagReturnOrHandle parameter below and the WinExecIsRunning function.
The name of a project tag that will store feedback about the execution of the command:
• If the command is executed asynchronously, then the tag will receive a handle that can used
with the WinExecIsRunning function to determine whether the command is still running.
• If the command is executed synchronously, then the tag will receive the command's exit
code. (This is separate from the function's own returned value.)
This is an optional parameter, but given its nature, there is no default value.
Note: The tag name must be enclosed in quotes, as shown in the syntax
diagram, or else the project will try to get the value of the named tag.
Returned value
This function returns the following possible values:
InduSoft Web Studio Page 623