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

damex_describeDataChainVal

This function is used to retrieve BLOB data passed into the query as a parameter.
int damex_describeDataChainVal(
    DAM_HVAL hVal,
    void ** ppVal,
    int * piValLen)
Table 187. Parameters for damex_describeDataChainVal
Parameter
Type
Description
IN
hcol
DAM_HVAL
The handle of the value.
OUT
ppVal
void **
The location to contain the pointer to the data.
piValLen
int *
The location to contain the number of bytes available.
RETURN
int
DAM_SUCCESS - valid value returned
DAM_FAILURE - on error
DAM_SUCCESS_WITH_RESULT_PENDING- When more column data is pending.
The IP code should call this function when damex_describeVal returns SQL_VAL_DATA_CHAIN as the data type.
damex_describeVal(hVal, &iType, ...)
switch (iType){
    case SQL_VAL_DATA_CHAIN:
    {
    void * pData;
    int iDataLen;
    damex_describeDataChainVal( hVal, &pData, &iDataLen);
    /* Now you can grab the data from the location */
    /* to which pData is pointing. */

See also

*damex_describeVal