4D Doc Center : ODBC

Home

4D v14.1

ODBC_SQLEndTran


ODBC_SQLEndTran ( handleType ; handleID ; completionType ) -> Function result

Parameter	Type	Description
handleType	Longint	Type of ID to pass to handleID
handleID	Longint	Either the statement ID or the connection ID
completionType	Longint	Either SQL_COMMIT or SQL_ROLLBACK
Function result	Longint	Returns the result of the MS ODBC API function SQLEndTran

Description

The ODBC_SQLEndTran command requests a commit or rollback operation for all active operations on all statements associated with a connection. ODBC_SQLEndTran can also request that a commit or rollback operation be performed for all connections associated with an environment.

If no transactions are active, ODBC_SQLEndTran returns SQL_SUCCESS with no effect on any data sources.

handleType defines which type of ID to pass to handleID and can have one of the following two values:

Constant	Description
SQL_HANDLE_STMT	Statement ID
SQL_HANDLE_DBC	Connection ID

handleID is the connectionID if handleType is equal to SQL_HANDLE_DBC. connectionID is a valid connection ID returned by ODBC_SQLAllocConnect and a connection must be established using the ODBC_SQLConnect command.

Otherwise, handleID is the stmtID, which is a valid statement ID returned by ODBC_SQLAllocStmt.

completionType can have one of the following two values:

Constant	Description
SQL_COMMIT	Commit changes
SQL_ROLLBACK	Rollback changes

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

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.