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

OASQLIP_init_param

This function is called for each input parameter that has been specified by the client application. It initializes the parameter with the specified value. All parameters values are passed as character string buffers.
int OASQLIP_init_param(
SQLIP_HSTMT sqlip_hstmt,
OADS_INTEGER iParam,
OADS_INTEGER iIndicator,
OADS_POINTER * pVal,
OADS_INTEGER iXODataType,
OADS_LEN iValLen);
 
Table 38: Parameters for OASQLIP_init_param 
Parameter
Type
Description
INPUT
 
 
sqlip_hstmt
SQLIP_HSTMT
Statement handle.
iParam
OADS_INTEGER
Parameter number – first parameter starts at 0.
iIndicator
OADS_INTEGER
Indicates whether the value is null terminated or is a valid NULL terminated string:
NULL_INDICATOR – the parameter’s value is NULL.
SQL_NTS – sValAsStr points to a null terminated string.
pVal
OADS_POINTER *
Parameter value input as a string except in the case of binary data. For binary data, this is a pointer to bytes representing the binary data. For Unicode data, this is an OAWCHAR pointer.
iXODataType
OADS_INTEGER
Data type of the parameter as specified by the client application. Use this information to determine how to interpret the value passed in as a string so that it can be passed to the backend data source accordingly.
iValLen
OADS_LEN
Length of the input value if the data type is XO_TYPE_VARBINARY or XO_TYPE_LONGVARBINARY. In this case, the pVal is assumed to point to a buffer of size iValLen.
RETURN
 
 
 
int
OADS_SUCCESS
OADS_ERROR