4D Doc Center : ODBC

Home

4D v14.1

ODBC_SQLFreeStmt


ODBC_SQLFreeStmt ( stmtID ; option ) -> Function result

Parameter	Type	Description
stmtID	Longint	Statement ID
option	Longint	Option to execute
Function result	Longint	Returns the result of the MS ODBC API function SQLFreeStmt

Description

The ODBC_SQLFreeStmt command stops the processing associated with a specific statement, closes any open cursors associated with the statement, discards pending results, or, optionally, frees all resources associated with the statement handle.

stmtID is a valid statement ID returned by ODBC_SQLAllocStmt.

The option parameter can take one of the following values:

Constants	Description
SQL_CLOSE	Closes the cursor associated with StatementHandle (if one was defined) and discards all pending results
SQL_UNBIND	Sets the SQL_DESC_COUNT field of the ARD to 0, releasing all column buffers bound by SQLBindCol for the given stmtID
SQL_RESET_PARAMS	Sets the SQL_DESC_COUNT field of the APD to 0, releasing all parameter buffers set by SQLBindParameter for the given stmtID
SQL_DROP	Frees the statement handle

For more information, please see the SQLFreeStmt function in the MS ODBC API Reference at http://msdn.microsoft.com/en-us/library/ms709284(VS.85).aspx.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

Example

See the example for the ODBC_SQLFetch command.