dam_describeIndexCol
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This function is used to retrieve the description of a column associated with the optimal index returned by the dam_getOptimalIndexAndConditions function. 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(
DAM_HINDEX_COL hIndexCol,
int * piSeqInIndex,
char * pszColName,
int * piCollation)
int dam_describeIndexColW(
DAM_HINDEX_COL hIndexCol,
int * piSeqInIndex,
OAWCHAR * pszColName,
int * piCollation)
Parameters for dam_describeIndexCol
| Parameter | Type | Description |
| IN | ||
| hIndexCol | DAM_HINDEX_COL | Index column handle as returned by the dam_getFirstIndexCol and dam_getNextIndexCol functions. |
| OUT | ||
| piSeqInIndex | int * | The sequence of this column in the index starting at 1. |
| pszColName | char * OAWCHAR * |
The name of the column. |
| piCollation | int * | Collation sequence: SQL_ORDER_ASC - for ascending SQL_ORDER_DESC - for descending |
| RETURN | ||
| int | DAM_SUCCESS - valid information returned DAM_FAILURE - failure |