damex_describeTableFunction and damex_describeTableFunctionW
- Last Updated: May 12, 2026
- 2 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
These are the pass through methods that return the attributes of the table function being processed. These methods are called from the IP to obtain the information about the table function for which ipExecute is called. Set the attribute value to NULL, if the attribute is not being used.
int damex_describeTableFunction (
DAM_HTABLE hTable,
int * piTableNum,
char * pCatalog,
char * pSchema,
char * pTableName,
char * pTablePath,
char * pUserData,
DAM_HVALEXP_LIST phValExpList,
int * piArgCount)
int damex_describeTableFunctionW (
DAM_HTABLE hTable,
int * piTableNum,
OAWCHAR * pCatalog,
OAWCHAR * pSchema,
OAWCHAR * pTableName,
OAWCHAR * pTablePath,
OAWCHAR * pUserData,
DAM_HVALEXP_LIST phValExpList,
int * piArgCount)
Parameters for damex_describeTableFunction and damex_describeTableFunctionW
| Parameter | Type | Description | ||
| INPUT | ||||
| hTable | DAM_HTABLE | The handle of the table object for which the attributes are requested. | ||
| OUTPUT | ||||
| piTableNum | int* | The table number for the table. Tables are numbered in the order in which they appear in the FROM clause of the select query, starting from 0. | ||
| pCatalog | char*OAWCHAR * | The table qualifier, as entered in the OA_TABLES table. Note: A buffer of 129 characters is required. |
||
| pSchema | char*OAWCHAR * | The table owner as entered in the OA_TABLES table. Note: A buffer of 129 characters is required. |
||
| pTableName | char*OAWCHAR * | The name of the table. Note: A buffer of 129 characters is required. |
||
| pTablePath | char*OAWCHAR* | The path of the table specified in the path column of the OA_TABLES table. This is an IP-specific field. Note: A buffer of 256 characters is required. |
||
| 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. Note: A buffer of 256 characters is required. |
||
| phValExpList | DAM_HVALEXP_LIST | The handle to the parameter list of the table function. | ||
| piArgCount | int* | Number of parameters of the table function. | ||
| RETURN | ||||
| DAM_ERROR/DAM_ SUCCESS | int | DAM_ERROR - if the handle passed is not of the table function. DAM_SUCCESS - ON SUCCESS |
||