beautypg.com

Visara Master Console Center Scripting Guide User Manual

Page 235

background image

Appendix B Command Syntax

Scripting Guide

235

Command Command

Type

Description Syntax

KEY

Console

Message

Enters a character string to

the specified console.

KEY(%Port,$Keys[,%Timeout])==>%RetCode

PORT

Console

Message

Returns the port number for

a console definition.

PORT(%Class[,$IconName])==>%Port

QCLOSE

Console

Message

Closes a message queue.

QCLOSE(%QueueID)

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)==>%RetCode

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)

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])

SCRNTEXT

Console
Message

A full or partial screen
snapshot—returns

characters from a console

screen.

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