DataDirect OpenAccess SDK Help

dam_describeJoinTable

Save PDF

dam_describeJoinTable

Save PDF

Last Updated: May 12, 2026
1 minute read

OpenAccess SDK
Version 9.0
Documentation

This function returns the attributes of the table with the given TableProcessOrder in the join query that is processing. This function is called from OAIP_execute by the IP to find details of each of the tables in the join query. You must pass buffers with enough memory for each of the values you need. Pass in NULL for any attribute in which you have no interest.

int dam_describeJoinTable(
    DAM_HSTMT  hstmt, 
    int        iTableProcessOrder,
    char *     pCatalog, 
    char *     pSchema, 
    char *     pTableName, 
    char *     pTablePath, 
    char *     pUserData)

int dam_describeJoinTableW(
    DAM_HSTMT  hstmt, 
    int        iTableProcessOrder,
    OAWCHAR *  pCatalog, 
    OAWCHAR *  pSchema, 
    OAWCHAR *  pTableName, 
    OAWCHAR *  pTablePath,
    OAWCHAR *  pUserData)

Parameters for dam_describeJoinTable / dam_describeJoinTableW

Parameter	Type	Description
IN
hstmt	DAM_HSTMT	The statement handle.
iTableProcessOrder	int	The process order of the table. Numbers start at 0.
OUT
pCatalog	char OAWCHAR	The table qualifier as entered in the OA_TABLES table.
pSchema	char * OAWCHAR *	The table owner as entered in the OA_TABLES table.
pTableName	char * OAWCHAR *	The name of the table.
pTablePath	char * OAWCHAR *	The path of the table specified in the path column of the OA_TABLES table. This is an IP-specific field.
pUserData	char * OAWCHAR *	The Table_Userdata as entered in the OA_TABLES table. This can be any string that the IP wants to associate with a table.
RETURN
	int	DAM_SUCCESS - found a table with matching iTableProcessOrder. DAM_NOT_AVAILABLE - invalid iTableProcessOrder. Matching table not found. DAM_FAILURE - The Query that is being processed is not a join query.