skip to main content
OpenAccess SDK SQL Engine Core Functions API : Function Reference : dam_getFirstCol
 

dam_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 dam_getNextCol function to step through the list.
The dam_getFirstCol function is used to:
*Write an IP that is dynamic in that it does not hard-code any column names.
*Optimize an IP where it first builds a row with only the columns in the WHERE clause and then adds the columns in the SELECT or UPDATE part of the query only if dam_isTargetRow returns TRUE.
DAM_HCOL dam_getFirstCol(
DAM_HSTMT hstmt,
int iColType)
Table 108. Parameters for dam_getFirstCol
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
The statement 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. The row must include at a minimum all columns that are in this category.
RETURN
DAM_HCOL
A handle to the first column that has the attributes of iColType. A NULL otherwise.

See also

*dam_getNextCol
*dam_isTargetRow