dam_describeIndexCol
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 9.0
- Documentation
This method is used to retrieve the description of a column associated with the optimal index returned by dam_getOptimalIndexAndConditions. The information for the index column is retrieved from the OA_STATISTICS table. Pass in NULL for any descriptor in which you have no interest.
int dam_describeIndexCol( long hIndexCol, xo_int piSeqInIndex, StringBuffer pszColName, xo_int piCollation)
Parameters for dam_describeIndexCol
| Parameter | Type | Description |
| INPUT | ||
| hIndexCol | long | Index column handle as returned by the dam_getFirstIndexCol and dam_getNextIndexCol methods. |
| OUTPUT | ||
| piSeqInIndex | xo_int | The sequence of this column in the index starting at 1. |
| pszColName | StringBuffer | The name of the column. |
| piCollation | xo_int | The collation sequence: SQL_ORDER_ASC - for ascending SQL_ORDER_DESC - for descending |
| RETURN | ||
| int | DAM_SUCCESS - valid information returned. DAM_FAILURE - failure. |
|