skip to main content
Interface Provider API : Reference : IP_FUNC_XXX
 

IP_FUNC_XXX

The IP must implement any function it has registered for handling custom scalar functions. When a scalar function is identified in a query, the OpenAccess SDK SQL engine first tries to find a match from its built-in functions. If it doesn't find a match, then it searches in the list of function registered by the IP as part of the INIT_SCALAR operation. If the OpenAccess SDK SQL engine finds a match in the IP registered list of scalar functions, it calls that function. Otherwise, an error is reported.
Refer to OpenAccess SDK SQL Engine Programmer's Guide for more information on OpenAccess SDK built-in and IP-defined scalar function processing.
DAM_HVAL ip_func_xxx(
    DAM_HSTMT hstmt,
    XM_Tree * pMemTree
    DAM_HVALEXP_LIST hValExpList)
Table 32. Parameters for ip_func_xxx
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
The statement handle of the currently active statement
pMemTree
XM_Tree *
The tree to be used for any memory allocation
hValExpList
DAM_HVALEXP_LIST
List of input arguments to be used by the function. This list is traversed and accessed using the OpenAccess SDK SQL engine functions dam_getFirstValExp, dam_getValueOfExpEx, and dam_getNextValExp.
RETURN
DAM_HVAL
Valid DAM_HVAL - creates an output value using the dam_createVal function
NULL - on failure

See also

*dam_getFirstValExp
*dam_getValueOfExpEx
*dam_getNextValExp
*dam_createVal