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

dam_createVal

This method is used to build the output value of a scalar function. NULL data is added by specifying the XO_NULL_DATA value flag for the column value length. The data must be provided in the same format as the output of the scalar function or in any format for which a conversion is supported. This method copies data from the user-supplied buffer to its internal buffers, so that the IP can free the memory associated with the input buffer (pColVal).
long dam_createVal(
     long pMemTree,
     int iXoType,
     Object pColVal,
     int iColValLen)
Table 137. Parameters for dam_createVal
Parameter
Type
Description
INPUT
pMemTree
long
The tree to use for allocating space.
iXoType
int
The type of the data. Must be the type defined as the output for this scalar function.
pColVal
Object
The data object. The Java type of the data should correspond to the iXoType value. See Table 33.
iColValLen
int
The length of the data.
XO_NULL_DATA - indicates a null value.
For VARCHAR, CHAR and NUMERIC either the length of the number of characters or XO_NTS to add the entire string.
For all other data types, pass in 0 or any value other than XO_NULL_DATA.
Note: The length value is required to allow OpenAccess SDK to validate that the correct size of data is passed in for the iXoType.
RETURN
long
non-null - valid handle to the return value.
0 - error adding the value.