skip to main content
SQL Engine Parse Tree API : SQL Engine Parse Tree functions reference : damex_describeValExp
 

damex_describeValExp

This function is used to retrieve the description of the value expression. The value expression has one of the following formats:
*value
*function(value) - function: MIN, MAX, AVG, SUM, COUNT, VAR, VAR_SAMP, STDDEV, STDDEV_SAMP, STDEV, VARP, VAR_POP, STDDEVP, STDDEV_POP, STDEVP
*COUNT(*)
*val_exp {+ | - | * | /} val_exp
*scalar_val_exp
int damex_describeValExp(
    DAM_HVALEXP hValExp,
    int* piType,
    int* piFuncType,
    DAM_HVALEXP* phLeftValExp,
    DAM_HVALEXP* phRightValExp,
    DAM_HVAL* phVal,
    DAM_HSCALAR_VALEXP* phScalarValExp
    DAM_HCASE_VALEXP* phCaseValExp);
Table 203. Parameters for damex_describeValExp
Parameter
Type
Description
IN
hValExp
DAM_HVALEXP
Value expression handle.
OUT
piType
int *
Type of the value expression:
*SQL_VAL_EXP_VAL
*SQL_VAL_EXP_ADD
*SQL_VAL_EXP_SUBTRACT
*SQL_VAL_EXP_MULTIPLY
*SQL_VAL_EXP_DIVIDE
*SQL_VAL_EXP_SCALAR
*SQL_VAL_EXP_CASE,
*SQL_VAL_EXP_RANK
piFuncType
int *
The type of the set function can be a bitwise OR of the following values:
*SQL_F_COUNT_ALL
*SQL_F_COUNT
*SQL_F_MIN
*SQL_F_MAX
*SQL_F_AVG
*SQL_F_SUM
*SQL_F_DISTINCT
*SQL_F_VAR
*SQL_F_VARP
*SQL_F_STDDEV
*SQL_F_STDDEVP
This value is NULL if no set function exists.
phLeftValExp
DAM_HVALEXP *
The handle to the left value expression. This value is set only when the value expression type is one of the following:
*SQL_VAL_EXP_ADD
*SQL_VAL_EXP_SUBTRACT
*SQL_VAL_EXP_MULTIPLY
*SQL_VAL_EXP_DIVIDE
The value is NULL otherwise.
phRightValExp
DAM_HVALEXP *
The handle to the right value expression. This value is set only when the value expression type is one of the following:
*SQL_VAL_EXP_ADD
*SQL_VAL_EXP_SUBTRACT
*SQL_VAL_EXP_MULTIPLY
*SQL_VAL_EXP_DIVIDE
*SQL_VAL_EXP_CASE,
*SQL_VAL_EXP_RANK
The value is NULL otherwise.
phVal
DAM_HVAL *
The handle to the value. This value is set only when the value expression type is SQL_VAL_EXP_VAL.
phScalarValExp
DAM_HSCALAR_​VALEXP *
The handle to the scalar value. This value is set only when the value expression type is SQL_VAL_EXP_SCALAR.
Use damex_getFirstValExp, damex_getNextValExp to navigate the argument list.
phCaseValExp
DAM_HCASE_​VALEXP *
The handle to the case value. This value is set only when the value expression type is SQL_VAL_EXP_CASE.
Use damex_describeCaseValExp to get details.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure

See also

*damex_describeCaseValExp
*damex_getFirstValExp
*damex_getNextValExp