4D v13

ODBC_SQLEndTran

Home

 
4D v13
ODBC_SQLEndTran

ODBC_SQLEndTran 


 

ODBC_SQLEndTran ( handleType ; handleID ; completionType ) -> Function result 
Parameter Type   Description
handleType  Longint in Type of ID to pass to handleID
handleID  Longint in Either the statement ID or the connection ID
completionType  Longint in Either SQL_COMMIT or SQL_ROLLBACK
Function result  Longint in Returns the result of the MS ODBC API function SQLEndTran

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:

ConstantDescription
SQL_HANDLE_STMTStatement ID
SQL_HANDLE_DBCConnection 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:

ConstantDescription
SQL_COMMITCommit changes
SQL_ROLLBACKRollback 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.

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

 
PROPERTIES 

Product: 4D
Theme: ODBC_End connection
Number: 16929

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D ODBC Pro 2004

 
SEE ALSO 

ODBC_SQLAllocStmt
ODBC_SQLConnect