DataDirect OpenAccess SDK Help

dam_describeTableByProcessOrder/ dam_describeTableByProcessOrderW

Save PDF

dam_describeTableByProcessOrder/ dam_describeTableByProcessOrderW

Save PDF

Last Updated: May 12, 2026
2 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 the EXECUTE function 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 that you have no reason to define.

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

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

Parameters for dam_describeTableByProcessOrder/ dam_describeTableByProcessOrder

Parameter	Type	Description
IN
hstmt	DAM_HSTMT	The statement handle.
iTableProcessOrder	int	The process order of the table. Numbers start at 0.
OUT
piTableNum	int *	The table number for the table. Tables are numbered in the order they appear in the FROM clause of the select query starting at 0.
pCatalog	char * OAWCHAR *	The table qualifier as entered in the OA_TABLES table. Pass in a buffer of 128 characters.
pSchema	char * OAWCHAR *	The table owner as entered in the OA_TABLES table. Pass in a buffer of 128 characters.
pTableName	char * OAWCHAR *	The name of the table. Pass in a buffer of 128 characters.
pTablePath	char * OAWCHAR *	The path of the table specified in the path column of the OA_TABLES table. This is an IP specific field. Pass in a buffer of 256 characters.
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. Pass in a buffer of 256 characters.
RETURN
	int	DAM_SUCCESS - found a table with matching iTableProcessOrder. DAM_NOT_AVAILABLE - invalid iTableProcessOrder. Matching table not found. DAM_FAILURE - The query being processed is not a join query.