Powered by Zoomin Software. For more details please contactZoomin

DataDirect OpenAccess SDK Help

Table of Contents

damex_describeValExp

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: August 19, 2026
  • 2 minute read
    • OpenAccess SDK
    • Version 9.0
    • Documentation

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,
    DAM_HRANK_VALEXP*    phRankValExp);

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. Use damex_describeVal to get the details of the value.
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_describeScalarValExp to get the details of the scalar method.
Use damex_getFirstValExp and damex_getNextValExp to navigate the argument list returned by damex_describeScalarValExp.
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.
phRankValExp DAM_HRANK_​VALEXP * The handle to the rank value expression. This value is set only when the value expression type is SQL_VAL_EXP_RANK.
Use damex_describeRankValExp to get the rank subtype and the associated ORDER BY and PARTITION BY value-expression lists.
RETURN
int DAM_SUCCESS - on success
DAM_FAILURE - on failure

See also

Alert