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

dam_describeColResAlias

This method is used to get the result column alias description for the specified column. You must set up buffers of at least DAM_MAX_ID_LEN+1 for the identifier names that are returned by this method. Pass in NULL for any attributes that you do not want. To get the first result alias, pass 1 for bFirst. The IP can continue calling the method by passing 0 for bFirst to get all result alias descriptions.
int dam_describeColResAlias(
long         hstmt,
long         hcol,
int          bFirst,
StringBuffer pAliasName,
xo_long      phcolAlias)
Table 140. Parameters for dam_describeColResAlias
Parameter
Type
Description
INPUT
hstmt
long
The statement handle.
hcol
long
The column handle.
bFirst
int
Pass in 1 to get the first alias and 0 to get next.
OUTPUT
pAliasName
StringBuffer
The result alias name.
phColAlias
xo_long
The result alias column handle. Use this column handle when the IP returns a value for the result column using dam_addColAliasxxxValToRow.
RETURN
int
DAM_SUCCESS - on success
DAM_FAILURE - on failure
DAM_NOT_AVAILABLE - when no result columns match the input column handle.

See also

*dam_addColAliasxxxValToRow