SetRowNum Method (DATATABLE)
10.5, PLBCMP GUI Only
The SetRowNum method stores a numeric input value into a specified column item in a DATATABLE object. This method uses the following format:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A DATATABLE object.
return
Optional. A Numeric Variable thay receives the item's text.
row
Required. A Numeric Variable that specifies the zero-based row accessed.
value
Required. A Numeric Variable that is stored into a DATATABLE column item as a numeric string.
column
Optional. A Numeric Variable that specifies the zero-based column accessed.
format
Optional. A decimal number or Numeric Variable that specifies the format used for the data being stored.
Flags Affected: EOS, OVER, ZERO
Note the following:
The {col} specifies that the text is to associate with a child column item of {row}. If not given, zero is assumed and the text of the left most column item 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 |
Description |
|
0 |
The input INTEGER value is stored into the DATATABLE item as a decimal string. This is the same as the default behavior when{format} is not specified. |
|
1 |
The input INTEGER value is stored into the DATATABLE item as a hexadecimal string with a leading '0x' identifier |
See Also: GetRowNum, DATATABLE Methods
|