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

dam_describeJoinTable

This method returns the attributes of the table with the given TableProcessOrder in the join query being processed. This method is called from ipExecute to get the details about each of the tables in the join query. Pass in NULL for any attribute in which you have no interest.
int dam_describeJoinTable(
int64 hstmt,
int iTableProcessOrder,
StringBuilder pCatalog,
StringBuilder pSchema,
StringBuilder pTableName,
StringBuilder pTablePath,
StringBuilder pUserData);
 
Table 115: Parameters for dam_describeJoinTable 
Parameter
Type
Description
IN
 
 
hstmt
int64
The statement handle
iTableProcessOrder
int
The process order of the table. Numbers start at 0.
OUT
 
 
pCatalog
StringBuilder
The table qualifier as entered in the OA_TABLES table.
pSchema
StringBuilder
The table owner as entered in the OA_TABLES table
pTableName
StringBuilder
The name of the table
pTablePath
StringBuilder
The path of the table specified in the path column of the OA_TABLES table. This is an IP specific field.
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.
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.