Returns the value of the specified column as bool.
Syntax
XIH.GetBool(colcaption)
XIH.GetBool(colcaption, offset)
XIH.GetBool(colIndex)
XIH.GetBool(colIndex, offset)
Parameters
Parameter | Data type | Description | Sample |
---|---|---|---|
colcaption | string | String specifies the columns caption. | "col1" |
colIndex | int | Index of a column | 1 |
offset | int | Optionally specifies the row offset. Default is 1 | 1 |
Remarks
ColumnIndex is zero-based.
A statement with an offset returns 'false' after reaching the end of the column due to the offset.
Can convert: double, Int32, string.
Returns a boolean.
Examples
XIH.GetBool(
"Holiday"
)
XIH.GetBool(
"Holiday"
, 2)
Related
- TIS Parameters
- XIH Functions