skip to main content
OpenAccess SDK SQL Engine Core Functions API : Custom scalar functions : dam_describeCustomCond
 

dam_describeCustomCond

This function is used to retrieve the description of a custom condition, including the column, operator, name of the scalar function, and any parameters passed to the function.
int dam_describeCustomCond(
DAM_HSTMT hstmt,
DAM_HCOND hcond,
DAM_HCOL * phCol,
int * piOpType,
char * pScalarName,
DAM_HVALEXP_LIST * phValExpList)
Table 37. Parameters for dam_describeCustomCond
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
The statement handle.
hcond
DAM_HCOND
The custom condition handle.
OUT
phCol
DAM_HCOL *
The handle to the column associated with the condition.
piOpType
int *
The operator type. Refer to Table 80 for the description of supported operators and their associated values.
pScalarName
char *
The scalar function name.
phValExpList
DAM_HVALEXP_LIST *
The handle to the value expression list that contains the arguments to the scalar function.
RETURN
int
DAM_SUCCESS - valid condition is returned.
DAM_FAILURE - the operation failed.