Visara Master Console Center Scripting Guide User Manual

Page 249

Advertising
background image

Appendix B Command Syntax

Scripting Guide

249

Command Command

Type

Description Syntax

FREAD

File

Reads values from an open file into variables.

FREAD(%FielNum,var1[,var2,…,[varn]…])==>%
QtyRead

FRENAME

File

Renames a file.

FRENAME($CurrentName,$NewName)==>%

Success

FREWIND

File

Moves an open file’s current record pointer to the
beginning.

FREWIND(%FileNum)

FSEEK

File

Moves an open file’s current record pointer to a
byte offset.

FSEEK(%FileNum,%Position)==>%Success

FWRITE

File

Writes expression to an open file. FWRITE(%FileNum,expre[,%NEWLINE])==>%S

uccess

GETENV

Variable

Obtains the current value of the given

environment variable.

GETENV($Variable)==>$Value

GETPID

Variable

Obtains the system process identifier for this

script.

GETPID()==>%ProcessId

GOSUB

Flow
Control

Immediately transfers script execution to the
specified label and waits until the called routine

finishes execution.

GOSUB*Label

GOTO

Flow

Control

Immediately transfers script execution to the

specified label.

GOTO*Label

HEXSTR

Variable

Converts an integer to a hex string.

HEXSTR(%Number)==>$Hex

HUMID

Physical

Interface
Control

Reads the current humidity from a sensor unit.

HUMID(%Port)==>%Humidity

ICON

Alerting

Changes icon characteristics.

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

ICONMSG

Alerting

Returns an icon’s current message. ICONMSG([%Class[,$Name]])==>$Message

Advertising