Difference between revisions of "CATable::SetIndexOrder"
m (→Description) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[ | + | [[Category:ADE User Guide]] |
| − | + | [[ADE User Guide]] > [[ADE Server Class Reference]] > [[CATable]] | |
| − | = Description = | + | <languages /> |
| + | <translate> | ||
| + | = 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 8: | 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. | ||
| − | 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. | + | <!--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 or unless you have called [[CAGraphPivot::PivotTo]] for this table instance. | ||
| − | = 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 31: | 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]] | ||
| Line 38: | Line 46: | ||
* [[CATable::GetDataByElements]] | * [[CATable::GetDataByElements]] | ||
* [[CATable::GetDataByLabels]] | * [[CATable::GetDataByLabels]] | ||
| + | </translate> | ||
Latest revision as of 19:42, 8 March 2018
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 or unless you have called CAGraphPivot::PivotTo for this table instance.
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