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

dam_describeScalarEx2

This function is used to retrieve the description of the scalar function, including the qualifier name. When a scalar function that is registered with a qualifier in the IP 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 a scalar function supports a variable number of arguments.
int dam_describeScalarEx2(
DAM_HVALEXP_LIST hValExpList
char * pQualifierName,
char * pName,
int * piNoOfActualParams,
int * piResXoType,
int * piLength,
int * piPrecision,
int * piScale)
Table 88. Parameters for dam_describeScalarEx2
Parameter
Type
Description
IN
hValExpList
DAM_HVAL_EXP_LIST
The scalar function argument list handle.
OUT
pQualifierName
char *
The name of the function qualifier. Pass in a buffer of 128 characters.
pName
char *
The scalar function name. Pass in a buffer of 128 characters.
piNoOfActualParams
int *
The number of arguments passed to the scalar function.
piResXoType
int *
Type of scalar function result value.
piLength
int *
Maximum length of the scalar function result value.
piPrecision
int *
Precision of the scalar function result value.
piScale
int *
Scale of the scalar function result value.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure