dam_describeColResAlias

This function 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 returned by this function. Pass in NULL for any attributes you do not want. To get the first result alias, pass TRUE for bFirst. IP can continue calling the function by passing FALSE for bFirst to get all result alias descriptions.

int dam_describeColResAlias(
DAM_HSTMT hstmt,
DAM_HCOL hcol,
int bFirst,
char * pAliasName,
DAM_HCOL * phcolAlias)

int dam_describeColResAliasW(
DAM_HSTMT hstmt,
DAM_HCOL hcol,
int bFirst,
OAWCHAR * pAliasName,
DAM_HCOL * phcolAlias)

Table 76. Parameters for dam_describeColResAlias
Parameter	Type	Description
IN
hstmt	DAM_HSTMT	The statement handle.
hcol	DAM_HCOL	The column handle.
bFirst	int	Valid values are: TRUE - gets the first alias. FALSE - gets the next alias.
OUT
pAliasName	char * OAWCHAR *	The result Alias name.
phColAlias	DAM_HCOL *	The result Alias Column handle. This column handle should be used when IP returns value for the result column using dam_addColAliasValToRow.
RETURN
	int	DAM_SUCCESS - on success DAM_FAILURE - on failure DAM_NOT_AVAILABLE - when no result columns match the input column handle

dam_describeColResAlias

See also