beautypg.com

Visara Master Console Center Scripting Guide User Manual

Page 248

background image

Appendix B Command Syntax

Scripting Guide

248

Command Command

Type

Description Syntax

ERRORNUM

Misc.

Returns the error number for the most recent

command.

ERRORNUM()==>%ErrNum

EVENTCLOSE

Event Closes

an

event queue.

EVENTCLOSE( %QueueID ) ==> %Status

EVENTOPEN

Event

Opens a connection to the outside event daemon,

and asks for events from a particular source.

EVENTOPEN( %Source [, $OsNameArray] )

==> %QueueID

EVENTREAD

Event

Returns the next event from a specified event

queue.

EVENTREAD(%QueueIdArray,$EventArray[,

%Wait])==>%Status(%Source [,
$OsNameArray] ) ==> %QueueID

EXEC

Flow
Control

Executes a script whose name is stored in a
string expression.

EXEC($ScriptName[,Parm1,Parm1,…])==>Retur
nValue

FCLOSE

File

Closes an open file.

FCLOSE(%FileNum)

FDELETE

File

Permanently deletes a file.

FDELETE($FileName)==>%Success

FEXISTS

File

Determines if a file exists.

FEXISTS($FileName)==>%Success

FILENO

File

Obtains the system integer file descriptor from a
file handle.

FILENO(%FileHandle)==>%FileDescriptor

FINDSTR

Variable

Searches a string for a regular expression

pattern.

FINDSTR($String,$Substring==>$FoundText

FMODTIME

File

Returns the time value of a last modified

date/time stamp for a file.

FMODTIME(File)==>%EpochSeconds

FOPEN

File

Opens a file for I/O access.

FOPEN($FileName[,%Mode])==>%FileHandle

FORMATSTR

Variable

Formats a string by combining literal characters

with conversion specifications.

FORMATSTR($String[,expr1,[expr2,…,[exprn]

…]])

FPOS

File

Returns an open file’s current record pointer

position.

FPOS(%FileNum)==>%Position