DataDirect OpenAccess SDK Help

dam_describeCol

Save PDF

dam_describeCol

Save PDF

Last Updated: May 12, 2026
1 minute read

OpenAccess SDK
Version 8.1
Documentation

This function is used to retrieve the description of the specified column. You must set up buffer sizes of at least DAM_MAX_ID_LEN+1 for the identifier names returned by this function. Pass in NULL for any attributes you do not want.

The attributes for controlling how the column is used in the query are returned as a bitwise OR (|) of the column attributes. You must perform a bitwise AND (&) of the output with the column type (DAM_COL_IN_COND) to check for all the ways that the column is used.

void dam_describeCol(
    DAM_HCOL  hcol, 
    int *     piColNum, 
    char *    pColName, 
    int *     piXOType, 
    int *     piColType)

void dam_describeColW(
    DAM_HCOL  hcol, 
    int *     piColNum,
    OAWCHAR * pColName, 
    int *     piXOType,
    int *     piColType)

Parameters for dam_describeCol

Parameter	Type	Description
IN
hcol	DAM_HCOL	The column handle.
OUT
piColNum	int *	The column number as defined in the schema database.
pColName	char * OAWCHAR *	The column name.
piXOType	int *	The data type (see Table SQL Engine Data Types and the Corresponding C Types).
piColType	int *	How the column appears in the query is specified by the setting of one or more of the following flags: DAM_COL_IN_SCHEMA - column is defined in the schema database. This flag applies to all columns. DAM_COL_IN_RESULT - column is part of the SELECT list. DAM_COL_IN_CONDITION - column is part of the WHERE clause. DAM_COL_IN_UPDATE_VAL_EXP - column is part of an update value expression. DAM_COL_IN_USE - column is in use. This parameter is equal to setting all of the following flags:DAM_COL_IN_RESULT, DAM_COL_IN_CONDITION, and DAM_COL_IN_UPDATE_VAL_EXP.
RETURN
	NONE