DataDirect OpenAccess SDK Help

dam_describeTable/dam_describeTableW

Save PDF

dam_describeTable/dam_describeTableW

Save PDF

Last Updated: May 12, 2026
1 minute read

OpenAccess SDK
Version 8.1
Documentation

This function returns the attributes of the current table being processed. This function is called from the EXECUTE function of the IP to find out about the table for which the IP has been called.

Pass in NULL for any attribute that you have no reason to define.

void dam_describeTable(
    DAM_HSTMT hstmt, 
    char *    pCatalog, 
    char *    pSchema, 
    char *    pTableName, 
    char *    pTablePath, 
    char *    pUserData)

void dam_describeTableW(
    DAM_HSTMT hstmt, 
    OAWCHAR * pCatalog, 
    OAWCHAR * pSchema, 
    OAWCHAR * pTableName, 
    OAWCHAR * pTablePath, 
    OAWCHAR * pUserData)

Parameters for dam_describeTable/dam_describeTableW

Parameter	Type	Description
IN
hstmt	DAM_HSTMT	The statement handle.
OUT
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_Userdata 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.
RETURN
	NONE