beautypg.com

Visara Master Console Center Scripting Guide User Manual

Page 252

background image

Appendix B Command Syntax

Scripting Guide

252

QOPEN

Console

Message

Opens a new queue of OS printer console

messages.

QOPEN([%ObjIDArray])==>%QueueID

QPREVIEW

Console
Message

Previews the current message on the screen
(before it enters the queue).

QPREVIEW(%QueueID,$ResultArray)==>%Ret
Code

QREAD

Console
Message

Reads the next message from a message queue.

QREAD(%QueueID,$MsgArray,%Wait[<$Filter]
)

==>$MsgLine

QSKIP

Console

Message

Moves a current message pointer for a queue.

QSKIP(%QueueID,%Skip)

REPEAT

Flow
Control

Repeats a sequence of commands until an
expression evaluates to TRUE.

REPEAT…UNTIL

REPSTR

Variable

Returns a string repeated a specified number of
times.

REPSTR($String,%Count)==>$RepeatedString

RETURN

Flow

Control

Returns execution to the calling routine, passing

an optional return value.

RETURN[Expression]

RIGHTSTR

Variable

Returns the rightmost specified number of

characters of a string expression.

RIGHTSTR($String,%Count)==>$Substr

SCANB

Console

Message

Same as SCANP except for use with the

BLOCKSCSN command.

SCANB(%Port,$Text,*Found)

SCANP

Console
Message

Searches a console for a specified character
string.

SCANP(%Port,$Text,%Wait,*Found[,$Array])

SCRIPTCANCEL

Scriptin

g

Obtains the system integer file descriptor from a

file handle

SCRIPTCANCEL($ScriptName,$Class,$Name)

SCRIPTGETACTIVE

Scriptin

g

Retrieves information on all active scripts into an

associative array.

SCRIPTGETACTIVE($AssocArray)==>%ErrCod

e

SCRNTEXT

Console

Message

A full or partial screen snapshot—returns

characters from a console screen.

SCRNTEXT(%Port,%Start,%Length==>$Text

SECONDS

Time

Returns the time value for the current time.

SECONDS()==>%EpochSeconds