Visara Master Console Center Scripting Guide - Manual (Page 162)

Chapter 5 Script Commands
Scripting Guide 162
PORT
Syntax:
PORT( %Class[, $IconName]) ==> %Port
Description:
Returns the port number for a console definition.
Action: A console’s port number is returned for a class and an optional icon
name.
Parameters:
%Class. Numeric expression. The icon class. Refer to Icon Class/Icon
Name on page 29 for more information. The unique port sequence
type. Only CPU, OS, PRN, and SW are valid for the PORT function.
$IconName. String expression. Optional. The name of the icon
whose port number should be returned. If not specified, the icon used
is in the class specified by the port type that is in the same lineage as
the icon on which the script is executing.
Returns:
Numeric value, as follows:
Value
Meaning
-1 The requested console definition or port
does not exist.
Any other value The port number for the specified
console.
Notes: 1. Refer to Manifest Constants on page 42 for the constants reference list.
2. This command allows the QREAD command to read messages from
the printer queue.
3. The PORT command can be used to get the port number for an LU6.2
printer port. The MCC handles an LU6.2 printer port in the same
way as any other printer port. Note that there may be more than one
printer port per OS, for example, an LU6.2 printer port and a coax
printer port.
Example: %Port := PORT( OS)
%Port := PORT( CPU, “RS6000”)
%Port := PORT( CPU)
%Port := PORT( OS, “Prod1”)
See Also:
ICONNAME, QREAD