Iconname, Iconname, iconstat, Name, ico – Visara Master Console Center Scripting Guide User Manual

Page 133

Chapter 5 Script Commands

Scripting Guide

133

ICONNAME

Syntax:

ICONNAME( [%Class [, %Port]]) ==> $Name

Description:

Returns an icon’s name.

Action:

The name of the icon is returned for the specified class and port.

Parameters:

%Class. Numeric expression. Optional, but required if Port is

specified. The icon class. Refer to Icon Class/Icon Name on page 29
for more information. Valid constants are CPU, OS, SW, and PRN.
%Port. Numeric expression. Optional. The port number that the

object the icon represents is connected to. Refer to Ports on page 24 for
more information.

Returns:

String value. The name of the icon.
If Class and Port are not specified, the name of the current icon (the

icon that the script is executing on) is returned.
If Port is not specified but Class is, the name of the icon in the current
icon’s “lineage” in the specified class is returned.

Notes:

Refer to Manifest Constants on page 42 for the constants reference list.

Example:

$Name := ICONNAME()
$Name := ICONNAME( CPU)
$Name := ICONNAME( CPU, 2)