skip to main content
OpenAccess SDK SQL Engine Core Functions API : Function Reference : dam_add_damobj_proc
 

dam_add_damobj_proc

This function is used to return schema information about stored procedures. Add a procedure schema object with the specified values to the list of objects returned to the OpenAccess SDK SQL engine. Use the Unicode versions when using this function from OAIP_schemaW or OAIP_schemaExW.
All values should be set. Set Null values as follows:
*For char *, set the pointer to NULL.
*For integer, set the value to DAMOBJ_NOTSET.
Refer to "Schema Definition and Management" in the OpenAccess SDK SQL Engine Programmer's Guide for information about each of the values to set.
int dam_add_damobj_proc(
XM_Tree * pMemTree,
DAM_OBJ_LIST pList,
DAM_OBJ pSearchObj,
char * proc_qualifier,
char * proc_owner,
char * proc_name,
long num_input_params,
long num_output_params,
long num_result_sets,
short proc_type,
char * userdata,
char * remarks)
Table 43. Parameters for dam_add_damobj_proc
Parameter
Type
Description
IN
pMemTree
XM_Tree *
The memory tree on which to allocate memory for the new object.
pList
DAM_OBJ_LIST
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 have the OpenAccess SDK SQL engine filter the objects before adding to the list.
pSearchObj
DAM_OBJ
The 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.
proc_qualifier
char *
The name of the database in which the stored procedure exists.
proc_owner
char *
The owner of the stored procedure.
proc_name
char *
The name of the stored procedure.
num_input_params
long
The number of input parameters. Not used at this time.
num_output_params
long
The number of output parameters. Not used at this time.
num_result_sets
long
Number of result sets.
proc_type
short
Type of stored procedure.
userdata
char *
A place for the IP to maintain IP-specific data. The IP can read it by using dam_describeProcedure/dam_decribeProcedureW.
remarks
char *
The description of the stored procedure.
RETURN
int
Function call status:
DAM_SUCCESS - values set
DAM_FAILURE - values not set. One of the values was null when it cannot be.
int dam_add_damobj_procW(
XM_Tree * pMemTree,
DAM_OBJ_LIST pList,
DAM_OBJ pSearchObj,
OAWCHAR * proc_qualifier,
OAWCHAR * proc_owner,
OAWCHAR * proc_name,
long num_input_params,
long num_output_params,
long num_result_sets,
short proc_type,
OAWCHAR * userdata,
OAWCHAR * remarks)
Table 44. Parameters for dam_add_damaobj_procW
Parameter
Type
Description
IN
pMemTree
XM_Tree *
The memory tree on which to allocate memory for the new object.
pList
DAM_OBJ_LIST
The list on which the objects are to be added, which is passed in the call to the IP. The IP can pass the pSearchObj filter to have the OpenAccess SDK SQL engine filter the objects before adding to the list.
pSearchObj
DAM_OBJ
The 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.
proc_qualifier
OAWCHAR *
The name of the database in which the stored procedure exists.
proc_owner
OAWCHAR *
The owner of the stored procedure.
proc_name
OAWCHAR *
The name of the stored procedure.
num_input_params
long
The number of input parameters. Not used at this time.
num_output_params
long
The number of output parameters. Not used at this time.
num_result_sets
long
Number of result sets.
proc_type
short
Type of stored procedure.
userdata
OAWCHAR *
A place for the IP to maintain IP-specific data. The IP can read it by using dam_describeProcedure/dam_decribeProcedureW.
remarks
OAWCHAR *
The description of the stored procedure.
RETURN
int
Function call status:
DAM_SUCCESS - values set
DAM_FAILURE - values not set. One of the values was null when it cannot be.

See also

*dam_describeProcedure/dam_decribeProcedureW