Tclscriptexecutewithpriority - Newport XPS Programmer's Manual

XPS Unified
7.2.1.321

TCLScriptExecuteWithPriority

Name
TCLScriptExecuteWithPriority – Executes a TCL script with TCL task given
priority.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Priority mnemonic incorrect: (-17)
- Checks TCL file name: (-36)
- Checks TCL interpretor (task loading): (-37)
- Checks task name: (-47)
Description
This function executes a TCL script with a TCL task and a user-defined priority level.
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 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 to 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.
- PriorityLevel has three possible values: "HIGH", "MEDIUM" and "LOW", with the
order being HIGH >MEDIUM >LOW.
Prototype
int TCLScriptExecuteWithPriority(
int SocketID,
char * TCLFileName,
char * TaskName,
char * Priority,
char * InputArguments
)
Input parameters
SocketID
TCLFileName
TaskName
Priority
InputArguments
Output parameters
None.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * File name contains the TCL script.
char * Task name.
char * TCL task priority (HIGH, MEDIUM or LOW).
char * Input argument string (separator is a comma).
469
Programmer's Manual
EDH0373En1023 — 01/18