skip to main content
SQL Engine parse tree methods for Java : damex_describeCol
 

damex_describeCol

This method retrieves the description of the column. Pass in NULL for any attributes you do not want.
long damex_describeCol(
     long         hCol,
     xo_int       piTableNum,
     xo_int       piColNum,
     StringBuffer pColName,
     xo_int       piXOType,
     xo_int       piColType,
     StringBuffer pUserData,
     xo_int       piResultColNum)
Table 254. Parameters for damex_describeCol
Parameter
Type
Description
INPUT
hCol
long
The column handle.
piTableNum
xo_int
The table number of the table to which the column belongs.
piColNum
xo_int
The column number.
pColName
StringBuffer
The column name; create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
piXoType
xo_int
The data type of the column.
piColType
xo_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.
pUserData
StringBuffer
User data as specified in the schema. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
piResultColNum
xo_int
The result column number.
RETURN
long
DAM_SUCCESS - on success
DAM_FAILURE - on failure