dam_describeCol

This method is used to retrieve the description of the specified column. You must set up string buffers of at least DAM_MAX_ID_LEN+1 for the identifier names returned by this method. Pass in NULL for any attributes that you do not want.

The attributes for controlling how the column is used in the query are returned as a bitwise OR (|) of the column attributes. You must implement the IP to perform a bitwise AND (&) of the output with the column type (DAM_COL_IN_COND) to check for all the ways the column is used.

Table 138. Parameters for dam_describeCol
Parameter	Type	Description
INPUT
hcol	long	The column handle.
OUTPUT
piColNum	xo_int	The column number as defined in the schema database. Create and pass in an xo_int object.
pColName	StringBuffer	The column name. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
piXOType	xo_int	The data type (see Table 33). Create and pass in an xo_int object.
piColType	xo_int	Create and pass in an xo_int object. 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.