skip to main content
OpenAccess SDK SQL Engine core methods for Java : Exchanging data : dam_describeScalarEx
 

dam_describeScalarEx

This method 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 the IP registers the same scalar function to evaluate multiple scalar function names or when the scalar function supports a variable number of arguments.
int dam_describeScalarEx(
    long         hValExpList
    StringBuffer pName,
    xo_int       piNoOfActualParams,
    xo_int       piResXoType,
    xo_int       piLength,
    xo_int       piPrecision,
    xo_int       piScale)
Table 151. Parameters for dam_describeScalarEx
Parameter
Type
Description
INPUT
hValExpList
long
The handle of the scalar function argument list.
OUTPUT
pName
StringBuffer
Scalar function name
piNoOfActualParams
xo_int
The number of arguments passed to the scalar function.
piResXoType
xo_int
Scalar function result value type.
piLength
xo_int
Scalar function result value length.
piPrecision
xo_int
Scalar function result value precision.
piScale
xo_int
Scalar function result value scale.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure