dam_add_schemaobj
- Last Updated: May 12, 2026
- 2 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
This method adds a .NET schema object to the list of objects returned to the OpenAccess SDK SQL Engine. This method should be called by the IP to add a table, column, index, foreign key, procedure, or procedure column objects.
void dam_add_schemaobj(
int64 pMemTree,
int iType,
int64 pList,
object pSearchObj,
object pSchemaObj)
Parameters for dam_add_schemaobj
| Parameter | Type | Description |
| IN | ||
| pMemTree | int64 | The memory tree handle |
| iType | Int | Type of schema information being returned: AMOBJ_TYPE_CATALOG - catalogs DAMOBJ_TYPE_SCHEMA - schemas DAMOBJ_TYPE_TABLETYPE - table types DAMOBJ_TYPE_TABLE – tables information as defined by OA_TABLES DAMOBJ_TYPE_COLUMN – column information as defined by OA_COLUMNS DAMOBJ_TYPE_STAT – index information as defined by OA_STATISTICS DAMOBJ_TYPE_FKEY – foreign key information as defined by OA_FKEYS DAMOBJ_TYPE_PROC – procedures information DAMOBJ_TYPE_PROC_COLUMN – procedure columns information |
| pList | int64 | The list on which the objects are to be added. It is passed in the call to the IP. The IP can pass the pSearchObj filter to dam_add_schemaobj() to have the OpenAccess SDK SQL Engine filter the objects before adding to the list. |
| pSearchObj | object | The .NET schema object to use for filtering the objects added to the list. If you have taken care of only adding the object that are requested, then set this to NULL. If you want the OpenAccess SDK SQL Engine to do the filtering, then pass in the same value as passed into your IP. |
| pSchemaObj | object | .NET schema object. Depending upon iType, you will pass the schemaobj_xxx .NET object. The type of object to pass in is based on iType: DAMOBJ_TYPE_CATALOG - schemaobj_table DAMOBJ_TYPE_SCHEMA - schemaobj_table DAMOBJ_TYPE_TABLETYPE - schemaobj_table DAMOBJ_TYPE_TABLE – schemaobj_table DAMOBJ_TYPE_COLUMN – schemaobj_column DAMOBJ_TYPE_STAT – schemaobj_stat DAMOBJ_TYPE_FKEY – schemaobj_fkey DAMOBJ_TYPE_PKEY – schemaobj_pkey DAMOBJ_TYPE_PROC – schemaobj_proc DAMOBJ_TYPE_PROC_COLUMN - schemaobj_proccolumn |
| RETURN | ||
| Int | DAM_SUCCESS – on success DAM_FAILURE – on failure |