skip to main content
IP API Reference for C/C++ : IP API for C/C++ : OASQLIP_get_paramspec
 

OASQLIP_get_paramspec

This function returns the description for the specified parameter. This function will be called m times where m is the number of parameters returned by the OASQLIP_get_numparams function.
int OASQLIP_get_paramspec(
SQLIP_HSTMT sqlip_hstmt,
OADS_INTEGER iParmNum,
OADS_SMALLINT * iXoDataType,
OADS_SMALLINT * piNullable,
OADS_ULEN * piLen,
OADS_ULEN * piPrecision,
OADS_SMALLINT * piScale,
OADS_SMALLINT * piDirection)
 
Table 34: Parameters for OASQLIP_get_paramspec 
Parameter
Type
Description
INPUT
 
 
sqlip_hstmt
SQLIP_HSTMT
Statement handle
iParamNum
OADS_INTEGER
Parameter number – first parameter starts at  1.
OUTPUT
 
 
iXODataType
OADS_SMALLINT *
Data type of the parameter.
piNullalble
OADS_SMALLINT *
Whether the parameter can have null values.
1 – this parameter can have null values
0 – this parameter cannot have null values
piLen
OADS_ULEN *
Maximum length of the data for this parameter. Leave null for other types.
CHAR and VARCHAR – maximum length of the string
NUMERIC – precision + 2
piPrecision
OADS_ULEN *
Number of digits of mantissa precision.
• NUMERIC – number of digits
• CHAR and VARCHAR – set to same as piLen
• INTEGER=10
• SMALLINT=5
• DOUBLE=15
• REAL=7
• FLOAT=15
• DATE=10
• TIME=8
• TIMESTAMP=19
piScale
OADS_SMALLINT *
Total number of significant digits to the right of the decimal point. Only required for NUMERIC types.
piDirection
OADS_SMALLINT *
Direction of the parameter.
SQL_PARAM_TYPE_UNKNOWN (0)
SQL_PARAM_INPUT (1)
SQL_PARAM_INPUT_OUTPUT (2)
SQL_PARAM_OUTPUT (4)
SQL_PARAM_RETURN_VALUE (5)
RETURN
 
 
 
int
OADS_SUCCESS
OADS_ERROR
When a parameter value is subsequently sent to the IP layer from the client, the only information supplied is the actual data type of the parameter, its value as a string, and the length of the value. It is up to the IP layer to perform the appropriate binding with the backend data source based on information that it gathers and maintains during parameter description.

See also 

• OASQLIP_free_colval