Newport XPS-D - Tclscriptexecuteandwait

XPS Unified Programmer’s Manual
7.2.1.320 TCLScriptExecuteAndWait
Name
TCLScriptExecuteAndWait – Executes a TCL script and waits until the end of
execution.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks TCL file name: (-36)
- Checks TCL interpretor (task loading): (-37)
- Checks task name: (-47)
Description
This function executes a TCL program. The “TCLScriptExecuteAndWait” function is
different than the “TCLScriptExecute” function because it blocks the socket until the
script teminates. The TCL script file must be saved in the folder “..\Public\Scripts” of
the XPS controller. The file extension is “.tcl”.
• TaskName is a user designation for the TCL script in execution. If two TCL scripts
are executed at the same time with the same task name, The (-47) error is returned
because having the same TaskName is not allowed.
• InputArguments represents the input arguments of the TCL script to be executed.
The number of these input arguments is not limited but the string length is limited to
250 characters. The argument separator is a comma.
• OutputArguments represents the output arguments of the TCL script to be executed.
The number of these output arguments is not limited but the string length is limited
to 250 characters. The argument separator is a comma.
Prototype
int TCLScriptExecuteAndWait(
int SocketID,
char * TCLFileName,
char * TaskName,
char * InputArguments,
char * OutputArguments
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
TCLFileName char * File name contains the TCL script.
TaskName char * Task name.
InputArguments char * Input argument string (separator is a comma).
Output parameters
OutputArguments char * Output argument string (separator is a comma).
467 EDH0373En1023 — 01/18