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 method retrieves the description of the value expression. The value expression has one of the following formats:

  • value
  • function(value): – functions: 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(
int64     hValExp,
out int   piType,
out int   piFuncType, 
out int64 phLeftValExp,
out int64 phRightValExp,
out int64 phVal,
out int64 phScalarValExp,
out int64 phCaseValExp,
out int64 phRankValExp)

Parameters for damex_describeValExp

Parameter Type Description
IN    
hValExp int64 The value expression handle.
OUT    
piType int The 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 will be zero if no set function exists.
phLeftValExp int64 The handle to the left value expression. This value is set only when the val expression type is one of the following:
  • SQL_VAL_EXP_ADD
  • SQL_VAL_EXP_SUBTRACT
  • SQL_VAL_EXP_MULTIPLY
  • SQL_VAL_EXP_DIVIDE
Otherwise the value is zero.
phRightValExp int64 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
Otherwise the value is zero.
phVal int64 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 int64 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 int64 The handle to the case value expression. This value is set only when the value expression type is SQL_VAL_EXP_CASE.
Use damex_describeCaseValExp to get details.
phRankValExp int64 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 successDAM_FAILURE – on failure

See also

Alert