Updated on 2024-10-14 GMT+08:00

SQLBindParameter

Function

SQLBindParameter is used to bind parameter markers in an SQL statement to a buffer.

Prototype

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
SQLRETURN SQLBindParameter(SQLHSTMT       StatementHandle,    
                           SQLUSMALLINT   ParameterNumber,     
                           SQLSMALLINT    InputOutputType,
                           SQLSMALLINT    ValuetType,
                           SQLSMALLINT    ParameterType,
                           SQLSMALLINT    ColumnSize,
                           SQLSMALLINT    DecimalDigits,
                           SQLPOINTER     ParameterValuePtr,
                           SQLINTEGER     BufferLength,
                           SQLINTEGER     *StrLen_or_IndPtr);

Parameter

Table 1 SQLBindParameter parameters

Keyword

Parameter Description

StatementHandle

Statement handle.

ParameterNumber

Parameter marker number, starting with 1 and increasing in ascending order.

InputOutputType

Input/output type of the parameter.

ValueType

C data type of the parameter.

ParameterType

SQL data type of the parameter.

ColumnSize

Size of the column or expression of the corresponding parameter marker.

DecimalDigits

Digital number of the column or expression of the corresponding parameter marker.

ParameterValuePtr

Pointer to the storage parameter buffer.

BufferLength

Size of the ParameterValuePtr buffer in bytes.

StrLen_or_IndPtr

Pointer to the length or indicator of the buffer. If StrLen_or_IndPtr is null, no length or indicator is used.

Return Value

  • SQL_SUCCESS indicates that the call succeeded.
  • SQL_SUCCESS_WITH_INFO indicates that some warning information is displayed.
  • SQL_ERROR indicates major errors, such as memory allocation and connection failures.
  • SQL_INVALID_HANDLE indicates that invalid handles were called. This value may also be returned by other APIs.

Precautions

If SQLBindParameter returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, the application can call SQLGetDiagRec, with HandleType and Handle set to SQL_HANDLE_STMT and StatementHandle, respectively, to obtain the SQLSTATE value. The SQLSTATE value provides the detailed function calling information.

Example

See Examples.