Icon: _getValue

Icon: _getValue

Returns the numeric return value of an icon

Inherited from Widget

Syntax
Details
Example

Syntax

CALL NOTIFY (icon-name, '_getValue', icon-value);

Argument Type Description

icon-value
N returns the numeric return value associated with the icon. This value is blank if you did not select the icon.

Argument	Type	Description
icon-value	N	returns the numeric return value associated with the icon. This value is blank if you did not select the icon.

Details

If you assigned an icon a character return value in the Value on Selection window, the _getValue method causes a program halt. Use the _getText method to return the value of an icon that has a character return value.

Example

If the number 4 was assigned to the icon in the Value on Selection window, the _getValue method assigns the value 4 to the SCL variable VALUE:

   call notify('icon1','_get_value_',value);
   if (value=4) then
      _msg_= You have made reservations
             for four.';

You can also use simple SCL assignment statements or PUT statements to access the value of an icon. For example, if the return value for ICON1 is 123 and the icon is selected, the following statements will print icon1=123 and assign the value 123 to the SCL variable A:

   put icon1=;
   A = icon1;

However, remember that SCL statements and functions do not work across FRAME entry boundaries. To access the value of an icon in another FRAME entry, use the _getValue method instead.

Chapter Contents
Previous
Next
Top of Page