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

damex_getFirstCol

This function is used to navigate through the columns that appear in the SELECT, UPDATE and WHERE clause of the SQL query or through the columns in the schema definition of the table. Call this function with the column types to be navigated and then use the damex_getNextCol function to step through the list.
DAM_HCOL damex_getFirstCol(
    DAM_HTABLE hTable,
    int iColType);
Table 209. Parameters for damex_getFirstCol
Parameter
Type
Description
IN
hTable
DAM_HTABLE
The table handle.
iColType
int
Identifies the column list to navigate. Use a bitwise OR ( | ) of the following flags to scan through columns that are in multiple categories:
*DAM_COL_IN_SCHEMA - list of all columns as defined in the schema database.
*DAM_COL_IN_RESULT - list of columns that are part of the result set.
*DAM_COL_IN_CONDITION - list of columns that are in the WHERE clause.
*DAM_COL_IN_UPDATE_VAL_EXP - list of all columns that are part of update value expressions
*DAM_COL_IN_USE - list of columns that are either part of the result or are in the WHERE clause.
RETURN
DAM_HCOL
The handle to the first column that has the attributes of iColType. A NULL otherwise.

See also

*damex_getNextCol