Difference between revisions of "CAIndex::GetNumberByValue"
(Marked this version for translation) |
|||
| Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
| − | = int GetNumberByValue(value) = | + | = int GetNumberByValue(value) = <!--T:1--> |
| + | <!--T:2--> | ||
Returns the position of an index label in an index. | Returns the position of an index label in an index. | ||
| − | == Parameters == | + | == Parameters == <!--T:3--> |
| + | <!--T:4--> | ||
«value» : The index element to look up. Can be a number or text. | «value» : The index element to look up. Can be a number or text. | ||
| + | <!--T:5--> | ||
'''Question: Can it be a [[CAObject]], to find a [[handle]]?''' | '''Question: Can it be a [[CAObject]], to find a [[handle]]?''' | ||
| − | == Return value == | + | == Return value == <!--T:6--> |
| + | <!--T:7--> | ||
integer -- the 1-based position. | integer -- the 1-based position. | ||
| − | == API Errors == | + | == API Errors == <!--T:8--> |
| + | <!--T:9--> | ||
:22 - "Value not found in index" | :22 - "Value not found in index" | ||
| − | = Example Usage = | + | = Example Usage = <!--T:10--> |
| − | int n = stateIndex.GetNumberByValue("California"); | + | <!--T:11--> |
| + | int n = stateIndex.GetNumberByValue("California"); | ||
| − | = See Also = | + | = See Also = <!--T:12--> |
| + | <!--T:13--> | ||
* [[CAIndex::GetValueByNumber]] | * [[CAIndex::GetValueByNumber]] | ||
</translate> | </translate> | ||
Latest revision as of 01:17, 16 June 2015
ADE User Guide > ADE Server Class Reference > CAIndex
int GetNumberByValue(value)
Returns the position of an index label in an index.
Parameters
«value» : The index element to look up. Can be a number or text.
Question: Can it be a CAObject, to find a handle?
Return value
integer -- the 1-based position.
API Errors
- 22 - "Value not found in index"
Example Usage
int n = stateIndex.GetNumberByValue("California");
See Also
Comments
Enable comment auto-refresher