SQLGetData

Function

SQLGetData is used to retrieve data for a single column in the result set. It can be called for many times to retrieve data of variable lengths.

Prototype

SQLRETURN SQLGetData(SQLHSTMT        StatementHandle,
                     SQLUSMALLINT    Col_or_Param_Num,
                     SQLSMALLINT     TargetType,
                     SQLPOINTER      TargetValuePtr,
                     SQLLEN          BufferLength,
                     SQLLEN          *StrLen_or_IndPtr);

Parameter

Table 1 SQLGetData parameters

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_NO_DATA indicates that the SQL statement does not return a result set.
• SQL_INVALID_HANDLE indicates that invalid handles were called. This value may also be returned by other APIs.
• SQL_STILL_EXECUTING indicates that the statement is being executed.

Precautions

If SQLGetData 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 ODBC - Examples.