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

dam_describeCondEx

This method is used to retrieve the description of the condition. Use this method to retrieve the condition is (=, >, <, etc.) and the value of the operand is ('TAG', 100, etc.). It returns details of either the left or right part of the condition based on the input iCondPart. The right part only applies in a BETWEEN condition. For other conditions, when right part is requested, a value of 0 is returned for the Operator type. Each condition is described by the operator type, the value of the operand, and the data type of the operand value.
Object dam_describeCondEx(
long   hstmt,
long   hcond,
int    iCondPart,
xo_int iOpType,
xo_int iXOType,
xo_int iDataLen,
xo_int iStatus)
Table 145. Parameters for dam_describeCondEx
Parameter
Type
Description
INPUT
hstmt
long
Statement handle.
hcol
long
Condition handle.
iCondPart
int
Condition part (left or right) for which details are being requested. Pass one of the following:
DAM_COND_PART_LEFT
DAM_COND_PART_RIGHT
OUTPUT
iOpType
xo_int
Operator type. See Table 144 for the operators and the associated value. When details of a right part are requested for condition that does not have a right part, iOpTyp is set to 0.
iXOType
xo_int
Data type of the condition.
iDataLen
xo_int
Length of the data. XO_NULL_DATA indicates a NULL value.
iStatus
xo_int
DAM_SUCCESS - valid condition returned.
DAM_FAILURE - error getting a condition because the arguments to the call are invalid or the format of the data in the condition cannot be converted to the column type.
RETURN
Object
The object that represents the data portion of the condition. The format of the data depends on the data type of the condition as indicated by iXOType. Use this object only if iValLen is not set to XO_NULL_DATA. See Table 34.