DataDirect OpenAccess SDK Help

damex_describeVal

Save PDF

damex_describeVal

Save PDF

Last Updated: May 12, 2026
1 minute read

OpenAccess SDK
Version 8.1
Documentation

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)

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 SQL Engine Data Types and the Corresponding C Types.
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