beautypg.com

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

Page 246

background image

Appendix B Command Syntax

Scripting Guide

246

Command Syntax—By Command

Command Command

Type

Description Syntax

AICONNAMES

Variable

Fill an array with all of the icon names in a
class.

AICONNAMES($AssocArray,%Class,$ParentI
con)

ALARM

Alerting

Generates a repetitive alarm tone (beep) at the
workstation (Global WorkStation).

ALARM(%Operation)

ALEN

Variable

Returns the number of elements in the array.

ALEN(Array) ==>%Elements

ALERTCREATE

Alerting

Create a new alert.

ALERTCREATE(%Status,%State,$Source,$Ms
gText,$UserNote) ==>%AlertID

ALERTDEL

Alerting

Deletes an existing alert.

ALERTDEL( %AlertID) ==> %ErrCode

ALERTGETACTIVE

Alerting

Retrieves information on all active alerts into an
array.

ALERTGETACTIVE($AssocArray)==>%ErrCo
de

ALERTMOD

Alerting

Modifies the value of a field in an existing alert.

ALERTMOD(%AlertID,%AlertField,NewValue

)

==>%ErrCode

ARESET

Variable

Reset the contents of an array to “empty”.

ARESET(Array)

ASCII

Variable Returns

the

ASCII value of a character.

ASCII($String) ==>%Value

ASCRN

Console

Message

Fill an array with the full text of a console

screen.

ASCRN($Array,%Port)

ASORT

Variable

Sort a normal array. ASORT(NormArray,%Direction)

ASSOCKEYS

Variable

Populate a normal string array with the string

index keys of an associative array

ASSOCKEYS(AssocArray,$NormArray)

ATSTR

Variable

Returns the starting position of a substring

within a string.

ATSTR($String,$Substring)==>%StartPos