DataDirect OpenAccess SDK Help

dam_describeTableByProcessOrder

Save PDF

dam_describeTableByProcessOrder

Save PDF

Last Updated: May 12, 2026
1 minute read

OpenAccess SDK
Version 9.0
Documentation

This method returns the attributes of the table with the given TableProcessOrder in the join query being processed. This method is called from the ipExecute method by the IP to get details for each of the tables in the join query. Pass in NULL for any attribute in which you have no interest.

int dam_describeTableByProcessOrder(
    long         hstmt, 
    int          iTableProcessOrder,
    xo_int       piTableNum,
    StringBuffer pCatalog, 
    StringBuffer pSchema, 
    StringBuffer pTableName, 
    StringBuffer pTablePath, 
    StringBuffer pUserData)

Parameters for dam_describeTableByProcessOrder

Parameter	Type	Description
INPUT
hstmt	long	The statement handle.
iTableProcessOrder	int	The process order of the table. Numbers start at 0.
OUTPUT
piTableNum	xo_int	The table number for the table. Tables are numbered in the order that they appear in the from-clause of the select query starting at 0.
pCatalog	StringBuffer	The table qualifier as entered in the OA_TABLES table. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
pSchema	StringBuffer	The table owner as entered in the OA_TABLES table. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
pTableName	StringBuffer	The name of the table. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
pTablePath	StringBuffer	Path of the table specified in the path column of the OA_TABLES table. This is IP specific field. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
pUserData	StringBuffer	The Table_Userdata as entered in the OA_TABLES table. This can be any string that the IP wants to associate with a table. Create and pass in a StringBuffer of DAM_MAX_ID_LEN+1.
RETURN
	int	DAM_SUCCESS - found 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.