damex_describeTable
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 9.0
- 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(
long hTable,
xo_int piTableNum,
StringBuffer pCatalog,
StringBuffer pSchema,
StringBuffer pTableName,
StringBuffer pTablePath,
StringBuffer pUserData)
Parameters for damex_describeTable
| Parameter | Type | Description |
| INPUT | ||
| htable | long | The table handle. |
| OUTPUT | ||
| piTableNum | xo_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 | StringBuffer | The table qualifier as entered in the OA_TABLES table. |
| pSchema | StringBuffer | The table owner as entered in the OA_TABLES table. |
| pTableName | StringBuffer | The name of the table. |
| pTablePath | StringBuffer | The path of the table specified in the path column of the OA_TABLES table. This is an IP-specific field. |
| pUserData | StringBuffer | 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 | ||