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

dam_getJoinColValue

This function returns the column value of the table already processed. This method is used by the IP to get values for the join conditions for use in processing the inner table.
int dam_getJoinColValue(
DAM_HSTMT hstmt,
DAM_HCOL hcol,
int iXoType,
void ** ppVal,
int * piValLen)
Table 127. Parameters for dam_getJoinColValue
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
The statement handle.
hcol
DAM_HCOL
The column number of the column for which value is being requested.
iXoType
int *
The data type in which to return the column value.
OUT
ppVal
void **
The pointer to the data is returned in this location. The C type of the data corresponds to the iXoType value. See Table 33. Use this pointer only if the *piValLen is not set to XO_NULL_DATA. Do not attempt to free this data.
piValLen
int *
Length of the data pointed to by *ppVal.
XO_NULL_DATA - null data
XO_NTS - null terminated string
>= 0 - length of the data
RETURN
int
Status of the function call:
DAM_SUCCESS - all data retrieved.
DAM_SUCCESS_WITH_RESULT_PENDING - more data is available and should be retrieved by calling this function again. This occurs for a large LONGVARBINARY data.
DAM_FAILURE - error in getting the data. Most likely the data cannot be converted to the XO_Type asked for.