damex_describeVal
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This method retrieves the description of the value.
Object damex_describeVal(
long hVal,
xo_int piType,
xo_int piXoType,
xo_int piValLen,
xo_long phCol,
xo_long phquery,
x0_int piValStatus)
Parameters for damex_describeVal
| Parameter | Type | Description |
| INPUT | ||
| hVal | long | The value handle. |
| OUTPUT | ||
| piType | xo_int | The type of the value, which will be one of the following: |
| piXoType | xo_int | The data type of the literal value. The value is contained in the Object returned by this method. |
| piValLen | xo_int | The length of the value. |
| phCol | xo_long | The handle to the column value. Use damex_describeCol to get more details. |
| phQuery | xo_long | The handle to the query value. Use dam_getQueryFirstResultValueand dam_getQueryNextResultValue to get the values returned from the subquery. |
| piValStatus | xo_int | Status of the method call: DAM_SUCCESS - on success DAM_FAILURE - on failure |
| RETURN | ||
| Object | If piType is SQL_VAL_LITERAL, then an Object that represents the value of the literal. The format of the data depends on the type of the literal. See Table How the methods for Java return a value as an object. | |