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

damex_addColValToRow

This function is used to build up a row by adding values for columns of the tables involved in the query. This function requires the data to be passed in using the same data type as the column definition or in any format from which data conversion is supported. Character data can be added by supplying the length or marking the data as null terminated. NULL data is added by specifying the XO_NULL_DATA value flag for the value length.
This function copies data from the user supplied buffer to its internal buffers. The IP can free the memory associated with the input buffer (pColVal).
int damex_addColValToRow(
    DAM_HSTMT hstmt,
    DAM_HROW hRow,
    DAM_HCOL hCol,
    int iXoType,
    void * pColVal,
    long lColValLen)
Table 180. Parameters for damex_addColValToRow
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
The statement handle.
hRow
DAM_HROW
The row handle.
hCol
DAM_HCOL
The column handle.
iXoType
int
The type of the data. The data can be supplied in a format that corresponds to the column's definition in the schema or in any other format and the OpenAccess SDK SQL engine will perform the required conversion.
pColVal
void *
The pointer to the data; the C type of the data should correspond to the iXoType value. See Table 33.
lColValLen
long
The length of the data:
XO_NULL_DATA - indicates a null value.
For VARCHAR, CHAR and NUMERIC either the length of the string or XO_NTS if the string is null terminated.
For all other data types, the length of the data.
The length value is required so that OpenAccess SDK can validate that the correct data size is passed in for the iXoType.
RETURN
int
DAM_SUCCESS - added the value to the row.
DAM_FAILURE - error adding the value.