Difference between revisions of "CATable::SetIndexOrder"
(Marked this version for translation) |
|||
| Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
| − | = Description = | + | = Description = <!--T:1--> |
| + | <!--T:2--> | ||
Sets the order of the indexes in the table to the order of «indexNames», which must contain the | Sets the order of the indexes in the table to the order of «indexNames», which must contain the | ||
names of only and all the indexes of the table, assuming it has more than one index. This order | names of only and all the indexes of the table, assuming it has more than one index. This order | ||
| Line 10: | Line 11: | ||
[[CATable::GetDataByElements|GetDataByElements]] and [[CATable::GetDataByLabels|GetDataByLabels]] to access a cell in a table. | [[CATable::GetDataByElements|GetDataByElements]] and [[CATable::GetDataByLabels|GetDataByLabels]] to access a cell in a table. | ||
| + | <!--T:3--> | ||
The index order is also used as the table pivot by [[CATable::GraphToStream|GraphToStream]] and [[CATable::GraphToFile|GraphToFile]] unless the [[CATable::GraphWithStoredPivot|GraphWithStoredPivot]] property is set to true. | The index order is also used as the table pivot by [[CATable::GraphToStream|GraphToStream]] and [[CATable::GraphToFile|GraphToFile]] unless the [[CATable::GraphWithStoredPivot|GraphWithStoredPivot]] property is set to true. | ||
| − | = Data type = | + | = Data type = <!--T:4--> |
| + | <!--T:5--> | ||
bool | bool | ||
| − | = Example Usage = | + | = Example Usage = <!--T:6--> |
| − | Dim indexNames(2) | + | <!--T:7--> |
| + | Dim indexNames(2) | ||
indexNames(1) = "X" | indexNames(1) = "X" | ||
indexNames(2) = "Y" | indexNames(2) = "Y" | ||
tab.SetIndexOrder(indexNames) | tab.SetIndexOrder(indexNames) | ||
| − | = Remarks = | + | = Remarks = <!--T:8--> |
| − | = API errors = | + | = API errors = <!--T:9--> |
| + | <!--T:10--> | ||
* 24 – “Subscripts must be an array of variants” | * 24 – “Subscripts must be an array of variants” | ||
* 26 – “Lower bound of subscript array inaccessible” | * 26 – “Lower bound of subscript array inaccessible” | ||
| Line 33: | Line 38: | ||
* 52 – “Specified name is not an index of the array” | * 52 – “Specified name is not an index of the array” | ||
| − | = See Also = | + | = See Also = <!--T:11--> |
| + | <!--T:12--> | ||
* [[CATable::GetIndexOrder]] | * [[CATable::GetIndexOrder]] | ||
* [[CATable::SetDataByElements]] | * [[CATable::SetDataByElements]] | ||
Revision as of 01:14, 16 June 2015
ADE User Guide > ADE Server Class Reference > CATable
Description
Sets the order of the indexes in the table to the order of «indexNames», which must contain the names of only and all the indexes of the table, assuming it has more than one index. This order determines the order used by SetDataByElements, SetDataByLabels, GetDataByElements and GetDataByLabels to access a cell in a table.
The index order is also used as the table pivot by GraphToStream and GraphToFile unless the GraphWithStoredPivot property is set to true.
Data type
bool
Example Usage
Dim indexNames(2) indexNames(1) = "X" indexNames(2) = "Y" tab.SetIndexOrder(indexNames)
Remarks
API errors
- 24 – “Subscripts must be an array of variants”
- 26 – “Lower bound of subscript array inaccessible”
- 27 – “Upper bound of subscript array inaccessible”
- 28 – “Must specify at least one element in array”
- 52 – “Specified name is not an index of the array”
See Also
Comments
Enable comment auto-refresher