SQLBindCol
Description
Binds application data buffers to columns in a result set.
Prototype
1 2 3 4 5 6 | SQLRETURN SQLBindCol(SQLHSTMT StatementHandle, SQLUSMALLINT ColumnNumber, SQLSMALLINT TargetType, SQLPOINTER TargetValuePtr, SQLLEN BufferLength, SQLLEN *StrLen_or_IndPtr); |
Parameters
| Keyword | Description |
|---|---|
| StatementHandle | Statement handle. |
| ColumnNumber | Number of the column to be bound. The column number starts with 0 and increases in ascending order. Column 0 is the bookmark column. If no bookmark column is set, column numbers start with 1. |
| TargetType | C data type in the buffer. |
| TargetValuePtr | Output parameter: pointer to the buffer bound with the column. The SQLFetch function returns data in the buffer. If this parameter is a null pointer, StrLen_or_IndPtr is a valid value. |
| BufferLength | Length of the buffer pointed to by TargetValuePtr, in bytes. |
| StrLen_or_IndPtr | Output parameter: pointer to the length or indicator of the buffer. If the value is null, no length or indicator is used. |
Return Values
- 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 are called. This value may also be returned by other APIs.
Precautions
If SQLBindCol 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.
Examples
For details, see Typical Application Development Examples.
