Help Center/ GaussDB/ Developer Guide(Distributed_V2.0-3.x)/ Application Development Guide/ Development Based on ODBC/ ODBC Interface Reference/ SQLExecDirect
Updated on 2025-08-19 GMT+08:00
View PDF

SQLExecDirect

Description

Executes a prepared statement specified in this parameter. SQLExecDirect is the fastest method for executing only one SQL statement at a time.

Prototype

1
2
3
 
SQLRETURN SQLExecDirect(SQLHSTMT         StatementHandle,
                        SQLCHAR         *StatementText,     
                        SQLINTEGER       TextLength);

Parameters

Table 1 SQLExecDirect parameters

Keyword

Description

StatementHandle

Statement handle, obtained from SQLAllocHandle.

StatementText

SQL statement to be executed. Multiple statements cannot be executed at a time.

TextLength

Length of StatementText.

Return Values

  • SQL_SUCCESS indicates that the call succeeded.
  • SQL_SUCCESS_WITH_INFO indicates that some warning information is displayed.
  • SQL_NEED_DATA indicates that parameters provided before executing the SQL statement are insufficient.
  • 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.
  • SQL_STILL_EXECUTING indicates that the statement is being executed.
  • SQL_NO_DATA indicates that the SQL statement does not return a result set.

Precautions

If SQLExecDirect 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.

Parent topic: ODBC Interface Reference