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

dam_add_damobj_proc_column

This function is used to return schema information about procedure columns. Add a procedure column 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: 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 OpenAccess SDK SQL Engine Programmer's Guide for information about each of the values to set.
int dam_add_damobj_proc_column(
XM_Tree * pMemTree,
DAM_OBJ_LIST pList,
DAM_OBJ pSearchObj,
char * qualifier,
char * owner,
char * name,
char * column_name,
short column_type,
short data_type,
char * type_name,
long precision,
long length,
short scale,
short radix,
short nullable,
char * userdata,
char * remarks)
Table 45. Parameters for dam_add_damobj_proc_column
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 objects 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.
qualifier
char *
The name of the database in which the table is created.
owner
char *
The owner of the table.
name
char *
The name of the table.
column_name
char *
The name of the column of the specified table.
column_type
short
Whether the procedure column is a parameter or a result set column.
data_type
short
The data type of the column.
type_name
char *
The X/Open data type name.
precision
long
The number of digits of mantissa precision.
length
long
The maximum length for character data types.
scale
short
The number of significant digits to the right of the decimal point.
radix
short
Reserved for future use.
nullable
short
Whether the column can be null.
userdata
char *
Any proprietary data about the column that the IP wants to access. The IP uses the dam_describeColDetail to get this information.
remarks
char *
The description of this procedure column.
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_proc_columnW
(XM_Tree * pMemTree,
DAM_OBJ_LIST pList,
DAM_OBJ pSearchObj,
OAWCHAR * qualifier,
OAWCHAR * owner,
OAWCHAR * name,
OAWCHAR * column_name,
short column_type,
short data_type,
OAWCHAR * type_name,
long precision,
long length,
short scale,
short radix,
short nullable,
OAWCHAR * userdata,
OAWCHAR * remarks)
Table 46. Parameters for dam_add_damobj_proc_columnW
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.
qualifier
OAWCHAR *
The name of the database in which the stored procedure exists.
owner
OAWCHAR *
The owner of the table.
name
OAWCHAR *
The name of the table.
column_name
OAWCHAR *
The name of the column of the specified table.
column_type
short
Whether the procedure column is a parameter or a result set column.
data_type
short
The data type of the column.
type_name
OAWCHAR *
The X/Open data type name.
precision
long
The number of digits of mantissa precision.
length
long
The maximum length for character data types.
scale
short
The number of significant digits to the right of the decimal point.
radix
short
Reserved for future use.
nullable
short
Whether the column can be null.
userdata
OAWCHAR *
Any proprietary data about the column that the IP wants to access. The IP uses the dam_describeColDetail to get this information.
remarks
OAWCHAR *
The description of this procedure column.
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_describeColDetail