dam_describeTable
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 9.0
- Documentation
This method returns the attributes of the current table being processed. This method is called from ipExecute to find out about the table for which the IP has been called. You must pass buffers with enough memory for each of the values you need. Pass in NULL for any descriptor in which you have no interest.
void dam_describeTable(
int64 hstmt,
StringBuilder pCatalog,
StringBuilder pSchema,
StringBuilder pTableName,
StringBuilder pTablePath,
StringBuilder pUserData)
Parameters for dam_describeTable
| Parameter | Type | Description |
| IN | ||
| hstmt | int64 | The statement handle |
| 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 | 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 know about the table. |