skip to main content
OpenAccess SDK SQL Engine core methods for .NET : Methods for .NET reference : dam_describeTableByProcessOrder
 

dam_describeTableByProcessOrder

This method returns the attributes of the table with the given TableProcessOrder in the join query being processed. This method is called from the EXECUTE 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(
int64 hstmt,
int iTableProcessOrder,
out int piTableNum,
StringBuilder pCatalog,
StringBuilder pSchema,
StringBuilder pTableName,
StringBuilder pTablePath,
StringBuilder pUserData)
 
 
Table 120: Parameters for dam_describeTableByProcessOrder 
Parameter
Type
Description
IN
 
 
hstmt
int64
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
StringBuilder
The table qualifier as entered in the OA_TABLES table. Create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
pSchema
StringBuilder
The table owner as entered in the OA_TABLES table. Create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
pTableName
StringBuilder
The name of the table. Create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
pTablePath
StringBuilder
Path of the table specified in the path column of the OA_TABLES table. This is IP specific field. Create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
pUserData
StringBuilder
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 StringBuilder 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 being processed is not a join query.