Difference between revisions of "CATable::GetIndexObject"
(Marked this version for translation) |
|||
| Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
| − | = [[CATable]]::GetIndexObject(indexName) = | + | = [[CATable]]::GetIndexObject(indexName) = <!--T:1--> |
| + | <!--T:2--> | ||
Retrieves a [[CAIndex]] object of the [[CATable]] by its name. | Retrieves a [[CAIndex]] object of the [[CATable]] by its name. | ||
| + | <!--T:3--> | ||
If the «indexName» is not valid, returns Nothing (Null) and sets [[CAEngine::ErrorCode|ErrorCode]]. | If the «indexName» is not valid, returns Nothing (Null) and sets [[CAEngine::ErrorCode|ErrorCode]]. | ||
| − | = Return value = | + | = Return value = <!--T:4--> |
| + | <!--T:5--> | ||
[[CAIndex]] | [[CAIndex]] | ||
| − | = Example Usage = | + | = Example Usage = <!--T:6--> |
| + | <!--T:7--> | ||
<code> | <code> | ||
:dim AI as CAIndex | :dim AI as CAIndex | ||
| Line 20: | Line 24: | ||
</code> | </code> | ||
| − | = Error Codes = | + | = Error Codes = <!--T:8--> |
| + | <!--T:9--> | ||
:32 – “Index object not found” | :32 – “Index object not found” | ||
| − | = See Also = | + | = See Also = <!--T:10--> |
| + | <!--T:11--> | ||
* [[CATable::IndexNames]], [[CATable::IndexName]] | * [[CATable::IndexNames]], [[CATable::IndexName]] | ||
* [[CAIndex]] | * [[CAIndex]] | ||
* Analytica functions [[IndexNames]]() and [[IndexesOf]]() | * Analytica functions [[IndexNames]]() and [[IndexesOf]]() | ||
</translate> | </translate> | ||
Latest revision as of 01:07, 16 June 2015
ADE User Guide > ADE Server Class Reference > CATable
CATable::GetIndexObject(indexName)
Retrieves a CAIndex object of the CATable by its name.
If the «indexName» is not valid, returns Nothing (Null) and sets ErrorCode.
Return value
Example Usage
- dim AI as CAIndex
- Set AI = AObj.GetIndexObject (IndexName)
Error Codes
- 32 – “Index object not found”
See Also
- CATable::IndexNames, CATable::IndexName
- CAIndex
- Analytica functions IndexNames() and IndexesOf()
Comments
Enable comment auto-refresher