skip to main content
OpenAccess SDK SQL Engine Core Functions API : Function Reference : dam_describeScalar
 

dam_describeScalar

This function is used to retrieve the description of the scalar function. When the IP registered scalar function is called it can use this API call to get scalar function details. This is useful when an IP registers the same C function to evaluate multiple scalar function names or when scalar function supports variable number of arguments.
int dam_describeScalar(
DAM_HVALEXP_LIST hValExpList
char * pName,
int * piNoOfActualParams)
Table 86. Parameters for dam_describeScalar
Parameter
Type
Description
IN
hValExpList
DAM_HVAL_EXP_LIST
The scalar function argument list handle.
OUT
pName
char *
The scalar function name. Pass in a buffer of 128 characters.
piNoOfActualParams
int *
The number of arguments passed to the scalar function.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure