beautypg.com

Iconmsg – Visara Master Console Center Scripting Guide User Manual

Page 132

background image

Chapter 5 Script Commands

Scripting Guide

132

ICONMSG

Syntax:

ICONMSG( [%Class [, $Name]]) ==> $Message

Description:

Returns an icon’s current message.

Action:

The message text for the specified icon is returned.

Parameters:

%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:

String value. The icon’s message—the text that appears on the bottom

line of the icon.

Notes:

N/A

Example:

//Example 1
$MsgStr := ICONMSG()
LOG(LOG_EXEC, $MsgStr)
//Example 2
$IconName := “MCC OS”
%IconClass := OS
$MsgStr := ICONMSG(%IconClass, $IconName)
LOG(LOG_EXEC, $MsgStr)

See Also:

ICON, ICONNAME, ICONSTATUS