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

damex_describeVal

This function is used to retrieve the description of the value.
int damex_describeVal(
    DAM_HVAL hVal,
    int * piType,
    int * piXoType,
    void ** ppData,
    int * piValLen,
    DAM_HCOL * phCol,
    DAM_HQUERY * phQuery)
Table 202. Parameters for damex_describeVal
Parameter
Type
Description
IN
hVal
DAM_HVAL
The value handle.
OUT
piType
int *
The type of the value, which is one of the following:
*SQL_VAL_NULL
*SQL_VAL_QUERY
*SQL_VAL_COL
*SQL_VAL_LITERAL
piXoType
int *
Data type of the literal value.
ppData
void *
A pointer to the literal value. See Table 33.
piValLen
int
The location to contain the number of bytes available.
phCol
DAM_HCOL *
The handle to the column value.
phQuery
DAM_HQUERY *
The handle to the query value.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure