skip to main content
SQL Engine Parse Tree API : SQL Engine Parse Tree functions reference : damex_describeCol
 

damex_describeCol

This function retrieves the description of the column. You must pass buffers with enough memory for the column name. Pass in NULL for any attributes that you do not want.
int damex_describeCol(
    DAM_HCOL hCol,
    int * piTableNum,
    int * piColNum,
    char * pColName,
    int * piXOType,
    int * piColType,
    char * pUserData,
    int * piResultColNum)

int damex_describeColW(
    DAM_HCOL hCol,
    int * piTableNum,
    int * piColNum,
    OAWCHAR * pColName,
    int * piXOType,
    int * piColType,
    OAWCHAR * pUserData,
    int * piResultColNum)
Table 186. Parameters for damex_describeCol
Parameter
Type
Description
IN
hCol
DAM_HCOL
The column handle.
OUT
piTableNum
int *
The table number of the table to which the column belongs.
piColNum
int *
The column number.
pColName
char *
OAWCHAR *
Column name.
piXoType
int *
XO Type of the column.
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
pUserData
char *
OAWCHAR *
User data as specified in the schema.
piResultColNum
int *
Result column number.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure