beautypg.com

Icon – Visara Master Console Center Scripting Guide User Manual

Page 130

background image

Chapter 5 Script Commands

Scripting Guide

130

ICON

Syntax:

ICON( %Status[, $Message [, %Class [, $Name]]])

Description:

Changes icon characteristics.

Action:

The status/color, message, class, and name are changed for the specified

icon.

Parameters:

%Status. Numeric expression. The status number to set the icon to, and

consequently changes its color. The range of status numbers is from 1 to

16, as listed below.

Constant, if Available
STATUS_ERROR


STATUS_WARNING

STATUS_INPROCESS


STATUS_NORMAL




STATUS_DOWN

Value
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Default Message
Error


Warning

In Process


Normal




Down

Color
Red
VioletRed
HotPink
Orange
Yellow
Gold
White
Gray
PaleGreen
Aquamarine
VioletRed
Cyan
LightSkyBlue
LightSteelBlue
Blue
Brown

$Message. String expression. Optional. The text to appear on the

bottom line of the icon. The maximum number of characters is 10. A
message with length of greater than 10 is truncated to the first 10

characters.
%Class. Numeric expression. Optional, but required with Name. The
icon class. Refer to Icon Class/Icon Name on page 29 for more

information.

$Name. String expression. Optional. The icon name. Refer to Icon

Class/Icon Name on page 29 for more information.

Returns:

N/A.