DataDirect OpenAccess SDK Help

dam_describeIndex

Save PDF

dam_describeIndex

Save PDF

Last Updated: May 12, 2026
1 minute read

OpenAccess SDK
Version 9.0
Documentation

This method is used to retrieve the description of the optimal index returned by dam_getOptimalIndexAndConditions. The information for the index is retrieved from the OA_STATISTICS table. Pass in NULL for any descriptor in which you have no interest. The output parameters to this method are objects that must be created before this method is called.

int dam_describeIndex(
    long         hIndex, 
    StringBuffer pszIndexQualifier,
    StringBuffer pszIndexName,
    xo_int       piType,
    xo_int       piNonUnique,
    xo_int       piIndexLen)

Parameters for dam_describeIndex

Parameter	Type	Description
INPUT
hIndex	long	Index handle.
OUTPUT
pszIndexQualifier	StringBuffer	Qualifier of the index. Must create an object of type StringBuffer of size DAMOBJ_MAX_ID_LEN.
pszIndexName	StringBuffer	Name of the index. Must create an object of type StringBuffer of size DAMOBJ_MAX_ID_LEN.
ptType	xo_int	Type of information being returned: SQL_TABLE_STAT (0) - indicates a statistic for the table. SQL_INDEX_CLUSTERED(1) - indicates a clustered index. SQL_INDEX_HASHED(2) - indicates a hashed index. SQL_INDEX_OTHER(3) - indicates another type of index. Must create an object of type xo_int.
piNonUnique	xo_int	Indicates whether the index prohibits duplicate values: TRUE (1) - if the index values can be non-unique. FALSE (0) - if the index values must be unique.
piIndexLen	xo_int	The number of columns in this index. This number is as indicated in the OA_STATISTICS and does not reflect how many of the columns belonging to the index are part of the query.
RETURN
	int	DAM_SUCCESS - valid information returned. DAM_FAILURE - failure.

DataDirect OpenAccess SDK Help

dam_describeIndex

Table of Contents

dam_describeIndex

See also