Visara Master Console Center Scripting Guide - Manual (Page 257)

Index
Scripting Guide 257
Object Manager ...............................................26
icon class ..............................................................31
icon name .............................................................31
object action .........................................................29
object field............................................................28
object ID ...............................................................28
object key .............................................................27
object name...........................................................27
object type ............................................................26
object name ......................................................27
object type ........................................................26
OBJEXEC
Syntax—OBJEXEC( %ObjID, $Action[, Parms...])
==> ReturnValue............................................153
OBJGET
Syntax—OBJGET( %ObjID, $ObjFieldName) ==>
$CurrentValue ................................................154
OBJGETATTAY
Syntax—OBJGETARRAY( %ObjID,
$AssocArray) ==> %Success.........................155
OBJID
Syntax—OBJID( %Class, $ObjKeyExpr) ==>
%ObjectID .....................................................156
OBJIDARRAY
Syntax—OBJIDARRAY( %Class, %ObjIDParent,
%AssocArray) ................................................158
OBJSET
Syntax—OBJSET( %ObjID, $ObjFieldName,
$NewValue) ==> %ErrCode ..........................160
OBJSETARRAY
Syntax—OBJSETARRAY( %ObjID,
$AssocArray) ==> %Success.........................161
obsolete material ...........................................214
QUEUE ..............................................................227
READMSG ........................................................229
operators
mathematical ........................................................52
Overview ..........................................................14
PARMS
Syntax—PARMS var1[, var2 [, var3, ..., [varn]...]]]
.......................................................................163
PORT
Syntax—PORT(%Class[, $IconName]) ==> %Port)
.......................................................................164
Port Numbers ..................................................26
Ports.................................................................26
QCLOSE
Syntax—QCLOSE( %QueueID) ........................165
QOPEN
Syntax—QOPEN( [%ObjIdArray]) ==> %QueueID
.......................................................................166
QPREVIEW
Syntax—QPREVIEW( %QueueID, $ResultArray)
==> %RetCode...............................................168
QREAD
Syntax—QREAD( %QueueID, $MsgArray,
%Wait[, $Filter]) ==> $MsgLine ...................170
QSKIP
Syntax—QSKIP( %QueueID, %Skip)................172
QUEUE.............................See obsolete material
READMSG........................See obsolete material
REPEAT
Syntax—REPEAT...UNTIL............................... 173
REPSTR
Syntax—REPSTR( $String, %Count) ==>
$RepeatedString ............................................ 174
reserved scripts................................................17
#dier001.scr ......................................................... 18
#dier002.scr ......................................................... 18
#diernnn.scr ......................................................... 18
#difind.scr ............................................................ 18
#dilost.scr............................................................. 18
#dircnnn.scr ......................................................... 18
#dofind.scr ........................................................... 18
#dolost.scr ............................................................ 18
#logswap.scr ........................................................ 18
#pwrfind.scr ......................................................... 18
#pwrlost.scr.......................................................... 18
#shutdn.scr ........................................................... 19
#snserrs.scr........................................................... 18
#snsfind.scr .......................................................... 18
#snslost.scr........................................................... 18
#snsredv.scr ......................................................... 18
#startup.scr........................................................... 19
RETURN
Syntax—RETURN [Expression] ....................... 175
RIGHTSTR
Sytnax—RIGHTSTR( $String, %Count) ==>
$SubStr .......................................................... 176
SCANB
Syntax—SCANB( %Port, $Text, *Found)..... 177
SCANP
Syntax—SCANP( %Port, $Text, %Wait, *Found[,
$Array]) ......................................................... 178
script syntax ....................................................36
comments statements ........................................... 53
date/time .............................................................. 42
expressions........................................................... 56
label statements.................................................... 54
manifest constants................................................ 44
variables............................................................... 38
script writing guidelines .................................24
SCRIPTCANCEL
Syntax–
SCRIPTCANCEL($ScriptName,$Class,$Name)
....................................................................... 179
SCRIPTGETACTIVE
Syntax–SCRIPTGETACTIVE($AssocArray) ==>
%ErrCode ...................................................... 180
scripts
concepts ............................................................... 14
executing.............................................................. 20
gclrund.txt ............................................................ 20
master................................................................... 16
naming ................................................................. 16
reserved................................................................ 17
scripts executing scripts ....................................... 20
structuring ............................................................ 15
throttling execution .............................................. 20
scripts executing scripts..................................20
SCRNTEXT