ipSchemaEx
- Last Updated: May 12, 2026
- 2 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
You must implement this optional method in your IP if it is to support stored procedures with one or more runtime defined results. The OpenAccess SDK SQL Engine calls this method to get a list of procedure result columns. The GETSUPPORT method should return true for IP_SUPPORT_SCHEMA.
Note: This method is not required if the output result set of the stored procedure is fixed in terms of what columns are returned and you are only returning one result set.
int ipSchemaEx(
int64 hstmt,
int64 pMemTree,
int iType,
int64 pList,
object pSearchObj)
Parameters for ipSchemaEx
| Parameter | Type | Description |
| IN | ||
| hstmt | int64 | The OpenAccess SDK SQL Engine statement handle |
| pMemTree | int64 | The memory tree to be used for all memory allocation |
| iType | int | Type of schema information requestedDAMOBJ_TYPE_PROC_COLUMN – procedure columns information as defined by OA_PROCCOLUMNS |
| pSearchObj | object | Contains the information about search conditions for the requested object type. This information is used by the IP and by the OpenAccess SDK SQL Engine to filter out the information returned by the IP. For example, if the OpenAccess SDK SQL Engine needs only the columns for a specific table, it will set the table_name in the pSearchObj. The IP must use this information or pass the pSearchObj to the OpenAccess SDK SQL Engine when calling the dam_add_schemaobj method. It will be null if no search criteria is specified. For example, if the user issues a query SELECT * FROM oa_tables, pSearchObj will be null and the IP should return all the table objects. Access this data by typecasting this object based on the requested object type (iType) and then accessing the members methods to retrieve the required information:DAMOBJ_TYPE_PROC_COLUMN – schemaobj_proccolumn |
| pList | int64 | Requested object(s) are returned by placing them in this list using the dam_add_schemaobj call. The IP can pass the pSearchObj filter to the dam_add_schemaobj methods to have the OpenAccess SDK SQL Engine filter the objects before adding to the list. |
| RETURN | ||
| int | DAM_SUCCESS – on success DAM_FAILURE – on failure |