Tclscriptkill - Newport XPS Programmer's Manual

XPS Unified
7.2.1.322

TCLScriptKill

Name
TCLScriptKill – Kills a TCL script.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks semaphore to use the TCL interpretor: (-37)
- Checks TCL interpretor (task loading) and task name: (-38)
Description
This function kills a running TCL script selected using its task name. The task name is a
user designation for the TCL script in execution.
For the boot script, the task name is "BootScript".
Prototype
int TCLScriptKill(
int SocketID,
char * TaskName
)
Input parameters
SocketID
TaskName
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -37: TCL interpretor doesn't run.
• -38: TCL script can not be killed: Wrong task name or task does not run.
• -47: Wrong TCL task name: each TCL task name must be different.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Task name.
471
Programmer's Manual
EDH0373En1023 — 01/18