skip to main content
SQL Engine Parse Tree API : SQL Engine Parse Tree functions reference : damex_describeTable/damex_describeTableW
 

damex_describeTable/damex_describeTableW

This function is used to retrieve 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(
    DAM_HTABLE hTable,
    int * piTableNum,
    char * pCatalog,
    char * pSchema,
    char * pTableName,
    char * pTablePath,
    char * pUserData)

void damex_describeTableW(
    DAM_HTABLE hTable,
    int * piTableNum,
    OAWCHAR * pCatalog,
    OAWCHAR * pSchema,
    OAWCHAR * pTableName,
    OAWCHAR * pTablePath,
    OAWCHAR * pUserData)
Table 197. Parameters for damex_describeTable/damex_describeTableW
Parameter
Type
Description
IN
htable
DAM_HTABLE
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
char *
OAWCHAR *
The table qualifier as entered in the OA_TABLES table.
pSchema
char *
OAWCHAR *
The table owner as entered in the OA_TABLES table.
pTableName
char *
OAWCHAR *
The name of the table.
pTablePath
char *
OAWCHAR *
The path of the table specified in the path column of the OA_TABLES table.
This is an IP-specific field.
pUserData
char *
OAWCHAR *
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