damex_describeTable
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This method retrieves the description of a table. You must pass buffers with enough memory for each of the values you need. Pass in NULL for any attribute in which you have no interest.
void damex_describeTable(
int64 hTable,
out int piTableNum,
StringBuilder pCatalog,
StringBuilder pSchema,
StringBuilder pTableName,
StringBuilder pTablePath,
StringBuilder pUserData)
Parameters for damex_describeTable
| Parameter | Type | Description |
| IN | ||
| htable | int64 | The table handle. |
| OUT | ||
| 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 at 0. |
| 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 know about the table. |
| RETURN | ||
| NONE |