Queue – Visara Master Console Center Scripting Guide User Manual

Page 225

Chapter 6 Obsolete Material

Scripting Guide

225

QUEUE

Syntax:

QUEUE( Operation[, Port])

Description:

Starts (stops and resets) a queue of OS printer console messages.

Action:

A current message pointer in a script is set, reset, and cleared with the

QUEUE command.

Parameters:

Operation. Numeric Expression. Determines how a current message
pointer is manipulated. Refer to Table 23. Operation parameter

options for QUEUE command following for details.
Port. Numeric expression. Optional. The assigned OS printer console

port number the to create a queue for. If not specified, a queue is

created for the OS printer console on which the script is executing.

Returns

N/A.

Notes:

list.

2. The MCC has one large message queue that holds all of the

incoming printer console messages. The queue holds the most

recent 6500 messages. The oldest message is discarded when a

new message is added (a circular message queue).

3. Each script has multiple current message pointers into the

message queue. The message pointers are set and reset with the
QUEUE() command, and advanced with the READMSG()

command.

4. The next message in a queue is retrieved with the READMSG()

command.

5. QUEUE only creates a queue for OS printer console messages. If a

port is specified, it must be an OS printer console port. If a port is

not specified, the script must be executing on an OS icon.

6. Only QUEUE ( RESET) a queue that has had the QUEUE( ON)

command activated on it.

7. If an OS does not have a printer port defined, attempting to use the

QUEUE( ) and READMSG( ) commands on that OS will generate
run-time errors, but will not generate compile errors.

Example:

QUEUE( ON)
QUEUE( RESET)
QUEUE( OFF)

See Also:

READMSG