SetItemNum Method (LISTVIEW)
10.7, PLBCMP GUI Only
The SetItemNum method stores a numeric value into a specified item in a LISTVIEW object. The method uses the following format:
|
|
|
|
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A LISTVIEW object that is accessed.
return
Optional. A Numeric Variable that indicates the success or failure of the method.
index
Required. A decimal number or Numeric Variable that specifies the zero-based item or row being accessed.
value
Required. A Numeric Variable that is stored into a LISTVIEW item as a numeric string.
subitem
Optional. A zero-based decimal number or Numeric Variable that specifies the sub-item number.
format
Optional. A decimal number or Numeric Variable that specifies the format used for the data being stored when the {value} is a PL/B INTEGER.
Flags Affected: EOS, OVER, ZERO
Note the following:
The {sub-item} specifies that the text is to associate with a child item of {index}. If not given, zero is assumed and the text of the item label is set.
Upon completion, {return} will contain the status of the modification as follows. $TRUE and $FALSE are defined in PLBEQU.INC.
|
Value |
Constant |
The modification ... |
|
0 |
$FALSE |
failed. |
|
1 |
$TRUE |
was successful. |
If the value returned is zero, the ZERO Condition Flag is set.
The OVER and EOS Condition Flags are always cleared.
The {format} value is not used when the input {value} is a numeric string from a FORM. The {format} value is used when the input {value} is a value from an INTEGER. The {format} values are described as follows:
|
Value |
The value is stored as a |
|
0 |
decimal string. This is the same as the default behavior when {format} is not specified. |
|
1 |
hexadecimal string with a leading '0x' identifier. |
For improved performance in the Application Server environment, do not specify the optional return value and parameters unless needed.
See Also: GETITEMNUM, LISTVIEW Methods
|
|