beautypg.com

Command syntax—by command type – Visara Master Console Center Scripting Guide User Manual

Page 234

background image

Appendix B Command Syntax

Scripting Guide

234

Command Syntax—By Command Type

Command Command

Type

Description Syntax

ALARM

Alerting Generates

a

repetitive

alarm tone (beep) at the

workstation (Global
WorkStation).

ALARM(%Operation)

ALERTCREATE

Alerting

Create a new alert.

ALERTCREATE(%Status,%State,$Source,$MsgText,$User
Note)==>%AlertID

ALERTDEL

Alerting

Deletes an existing alert.

ALERTDEL( %AlertID) ==> %ErrCode

ALERTGETACTIVE

Alerting

Retrieves information on all
active alerts into an array.

ALERTGETACTIVE($AssocArray) ==>%ErrCode

ALERTMOD

Alerting

Modifies the value of a field
in an existing alert.

ALERTMOD(%AlertID,%AlertField,NewValue)
==>%ErrCode

ICON

Alerting Changes

icon

characteristics.

ICON(%Status[,$Message[,%Class[,$Name]]])

ICONMSG

Alerting

Returns an icon’s current

message.

ICONMSG([%Class[,$Name]])==>$Message

ICONNAME

Alerting

Returns an icon’s name.

ICONNAME([%Port]])==>$Name

ICONSTATUS

Alerting

Returns an icon’s current

status.

ICONSTATUS([%Class[,$Name]])==>%Status

ASCRN

Console
Message

Fill an array with the full
text of a console screen.

ASCRN($Array,%Port)

BLOCKSCAN

Console
Message

Enables up to 256 SCANB
commands to execute as a

group.

BLOCKSCAN(%Wait,*Timeout[,$Array])…ENDBLOCK