DataDirect OpenAccess SDK Help

damex_describeTableFunction/ damex_describeTableFunctionW

Save PDF

damex_describeTableFunction/ damex_describeTableFunctionW

Save PDF

Last Updated: May 12, 2026
2 minute read

OpenAccess SDK
Version 8.1
Documentation

These are the pass-through functions that return the attributes of the table function being processed. These functions are called from the IP to obtain the information about the table function for which OAIP_execute is called. Pass in NULL for any attributes that you do not want.

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
IN
hTable	DAM_HTABLE	The handle of the table object for which the attributes are requested.
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 from 0.
pCatalog	char* OAWCHAR *	The table qualifier, as entered in the OA_TABLES table. Pass in a buffer of 128 characters.
pSchema	char* OAWCHAR *	The table owner as entered in the OA_TABLES table. Pass in a buffer of 128 characters.
pTableName	char* OAWCHAR *	The name of the table. Pass in a buffer of 128 characters.
pTablePath	char* OAWCHAR*	The path of the table specified in the path column of the OA_TABLES table. This is an IP-specific field. Pass in a buffer of 256 characters.
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. Pass in a buffer of 256 characters.
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