Difference between revisions of "CATable::AtomicValue"
(Marked this version for translation) |
|||
| Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
| − | = [[CATable]]::AtomicValue() = | + | = [[CATable]]::AtomicValue() = <!--T:1--> |
| + | <!--T:2--> | ||
Retrieves the scalar value from a zero-dimensional [[CATable]] object. A zero-dimensional table results when a result is not an array, or when you call [[CATable::Slice|Slice]] or [[CATable::Subscript|Subscript]] on a one-dimensional array. | Retrieves the scalar value from a zero-dimensional [[CATable]] object. A zero-dimensional table results when a result is not an array, or when you call [[CATable::Slice|Slice]] or [[CATable::Subscript|Subscript]] on a one-dimensional array. | ||
| + | <!--T:3--> | ||
Once you have a [[CATable]] object, there are three approaches for accessing the individual cells. You can access cells by coordinate using [[CATable::GetDataByLabels]] and [[CATable::GetDataByElements]]; you can convert to a native array using [[CATable::GetSafeArray]]; or you can successively slice the array to get [[CATable]] table objects of lower dimension until you eventually bottom out at individual cells. When you use the last method, [[CATable::AtomicValue|AtomicValue]] is used to get the cell value. | Once you have a [[CATable]] object, there are three approaches for accessing the individual cells. You can access cells by coordinate using [[CATable::GetDataByLabels]] and [[CATable::GetDataByElements]]; you can convert to a native array using [[CATable::GetSafeArray]]; or you can successively slice the array to get [[CATable]] table objects of lower dimension until you eventually bottom out at individual cells. When you use the last method, [[CATable::AtomicValue|AtomicValue]] is used to get the cell value. | ||
| − | = Return value = | + | = Return value = <!--T:4--> |
| + | <!--T:5--> | ||
Variant. | Variant. | ||
| − | = Example Usage = | + | = Example Usage = <!--T:6--> |
| + | <!--T:7--> | ||
The table is set to the contents of the Visual Basic array. | The table is set to the contents of the Visual Basic array. | ||
<code> | <code> | ||
| Line 20: | Line 24: | ||
</code> | </code> | ||
| − | = Error Codes = | + | = Error Codes = <!--T:8--> |
| − | = See Also = | + | = See Also = <!--T:9--> |
| + | <!--T:10--> | ||
* [[CATable::Subscript]], [[CATable::Slice]] | * [[CATable::Subscript]], [[CATable::Slice]] | ||
* [[CATable::NumDims]] | * [[CATable::NumDims]] | ||
</translate> | </translate> | ||
Latest revision as of 01:05, 16 June 2015
ADE User Guide > ADE Server Class Reference > CATable
CATable::AtomicValue()
Retrieves the scalar value from a zero-dimensional CATable object. A zero-dimensional table results when a result is not an array, or when you call Slice or Subscript on a one-dimensional array.
Once you have a CATable object, there are three approaches for accessing the individual cells. You can access cells by coordinate using CATable::GetDataByLabels and CATable::GetDataByElements; you can convert to a native array using CATable::GetSafeArray; or you can successively slice the array to get CATable table objects of lower dimension until you eventually bottom out at individual cells. When you use the last method, AtomicValue is used to get the cell value.
Return value
Variant.
Example Usage
The table is set to the contents of the Visual Basic array.
- x = tab.AtomicValue
Enable comment auto-refresher