Scriptcancel – Visara Master Console Center Scripting Guide User Manual
Page 177

Chapter 5 Script Commands
Scripting Guide
177
SCRIPTCANCEL
Syntax:
SCRIPTCANCEL($ScriptName,$Class,$Name)
Description:
Obtains the system integer file descriptor from a file handle.
Action:
Cancels all active scripts that match the given input.
Parameters:
$ScriptName: String. The name of the script (file name) or "*" as a
wildcard to match all names.
$Class: String. Class name passed to script or "ALL" as a wildcard
to match all classes. Typical class names are: ROOM, CPU, OS,
UNIT. Refer to the <Icon Class/Icon Name> section for more
information.
$Name: String. The icon name passed to the script or "*" as a
wildcard to match all names. Refer to the <Icon Class/Icon Name>
section for more information.
Returns:
Numeric value, as follows:
-1 = Error occurred (invalid input parameters)
0 = Success
Example:
$OSName := ICONNAME(OS)
SCRIPTCANCEL("timeralert", "CPU", $OSName)
See Also: