skip to main content
OpenAccess SDK SQL Engine core methods for .NET : Methods for .NET reference : dam_describeIndexCol
 

dam_describeIndexCol

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(
int64 hIndexCol,
out int piSeqInIndex,
StringBuilder pszColName,
out int piCollation)
 
Table 113: Parameters for dam_describeIndexCol 
Parameter
Type
Description
IN
 
 
hIndexCol
int64
Index column handle as returned by the dam_getFirstIndexCol and dam_getNextIndexCol methods.
OUT
 
 
piSeqInIndex
int
The sequence of this column in the index starting at 1
pszColName
StringBuilder
The name of the column
piCollation
int
The collation sequence:
SQL_ORDER_ASC – for ascending
SQL_ORDER_DESC – for descending
RETURN
 
 
 
int
DAM_SUCCESS – valid information returned
DAM_FAILURE – failure

See also 

• dam_getFirstIndexCol
• dam_getNextIndexCol
• dam_getOptimalIndexAndConditions