Tclscriptexecute - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.319

TCLScriptExecute

Name
TCLScriptExecute – Executes a TCL script.
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 script. The TCL script file must be saved in the folder
"..\Public\Scripts" of the XPS controller.
• TaskName is a user designation for the TCL script being executed. 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.
Prototype
int TCLScriptExecute(
int SocketID,
char * TCLFileName,
char * TaskName,
char * InputArguments
)
Input parameters
SocketID
TCLFileName
TaskName
InputArguments
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -36: Unknown TCL file.
• -37: TCL interpretor does not run.
• -47: Wrong TCL task name: each TCL task name must be different.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * File name contains the TCL script.
char * Task name.
char * Input argument string (separator is a comma).
466
Programmer's Manual