DataDirect OpenAccess SDK Help

dam_describeTableFunction/dam_describeTableFunctionW

Save PDF

dam_describeTableFunction/dam_describeTableFunctionW

Save PDF

Last Updated: May 12, 2026
2 minute read

OpenAccess SDK
Version 8.1
Documentation

These functions return the attributes of the table function being processed. The dam_describeTableFunction/dam_describeTableFunctionW function is called from the OAIP_execute function of IP to find out the information about the table function for which the IP is called. Pass in NULL for any attributes that you do not want.

int dam_describeTableFunction (DAM_STMT hstmt,
				                 char * pCatalog,
				                 char * pSchema,
				                 char * pTableName,
						         char * pTablePath,
				                 char * pUserData,
				                 DAM_HVALEXP_LIST phValExpList,
			                     int  * piArgCount)

int dam_describeTableFunctionW (DAM_STMT hstmt,
 				                  OAWCHAR * pCatalog,
				                  OAWCHAR * pSchema,
				                  OAWCHAR * pTableName,
			                      OAWCHAR * pTablePath,
				                  OAWCHAR * pUserData,
				                  DAM_HVALEXP_LIST phValExpList,
 				                  int  * piArgCount)

Parameters for dam_describeTableFunction/ dam_describeTableFunctionW

Parameter	Type	Description
IN
hstmt	DAM_STMT	The handle of the table object for which the attributes are requested.
OUT
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 user data, as entered in the OA_TABLES table. This can be any string that the IP wants to know about the table.Pass in a buffer of 256 characters.
phValExpList	DAM_HVALEXP_LIST	The handle to the parameter list of the table function.
piArgCount	int*	The number of parameters of the table function.
RETURNS
DAM_ERROR/ DAM_SUCCESS	int	DAM_ERROR - if the handle passed is not of the table function. DAM_SUCCESS - ON SUCCESS