skip to main content
SQL Engine parse tree methods for .NET : SQL pass-through and advanced query methods reference : damex_describeCol
 

damex_describeCol

This method retrieves the description of the column. You must pass in buffers with enough memory for the column name. Pass in NULL for any attributes you do not want.
Int damex_describeCol(
int64 hCol,
out int piTableNum,
out int piColNum,
StringBuilder pColName,
out int piXOType,
out int piColType,
StringBuilder pUserData,
out int piResultColNum)
 
Table 211: Parameters for damex_describeCol 
Parameter
Type
Description
IN
 
 
hCol
int64
The column handle
OUT
 
 
piTableNum
int
The table number of the table to which the column belongs
piColNum
int
The column number
pColName
StringBuilder
The column name; create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
piXoType
int
The data 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 – the column is defined in the schema database. This flag applies to all columns.
DAM_COL_IN_RESULT – the column is part of the SELECT list.
DAM_COL_IN_CONDITION – the column is part of the WHERE clause.
DAM_COL_IN_UPDATE_VAL_EXP – column is part of an UPDATE value expression
pUserData
StringBuilder
User data as specified in the schema. Create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
piResultColNum
int
The result column number.
RETURN
 
 
 
int
DAM_SUCCESS – on success
DAM_FAILURE – on failure