HTransactionFree (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Special cases
Handling records during a transaction
Transactions and independent HFSQL context

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HTransactionFree (Function)

In french: HTransactionLibère

Available only with these kinds of connection

Transforms all the records "in transaction" into "normal" records if these records do not belong to a transaction currently in progress. If a record found in the specified data file is considered as being in transaction but does not belong to a transaction in progress, it is automatically freed.

Caution: this function is an advanced function. This feature must be used when it is not possible to cancel the transactions that have failed (deleted transaction files for example).

Versions 18 and later

This function is now available for Java applications.

New in version 18

This function is now available for Java applications.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Example

// Frees all the records in transaction that may be used
HTransactionFree(Customer)

Syntax

Freeing a data file Hide the details

<Result> = HTransactionFree([<Data file>])

<Result>: Boolean

True if the operation is performed,
False if a problem occurred. HErrorInfo returns more details about the error.

<Data file>: Optional character string (with quotes)

Name of the HFSQL Classic or Client/Server data file for which the records in transaction must be freed.
If this parameter is not specified, HTransactionFree handles the last data file used.

Freeing a record found in a data file Hide the details

<Result> = HTransactionFree([<Data file>, ] <Record number>)

<Result>: Boolean

True if the operation is performed,
False if a problem occurred. HErrorInfo returns more details about the error.

<Data file>: Optional character string (with quotes)

Name of the HFSQL Classic or HyperFileSQL Client/Server data file for which the record in transaction must be freed.
If this parameter is not specified, HTransactionFree handles the last data file used.

<Record number>: Integer

Number of the record to free.
If this parameter is equal to 0 or to the constant hRecNumCurrent, the function HTransactionFree will handle the current Record..

Remarks

Special cases

This function can only be used for the data files in HFSQL format. For all the other types of data files, this function has no effect and it returns True.
The records that cannot be read (locked records for example) are ignored.
Versions 21 and later
This function can be used to free the transactions performed on data files found in a HFSQL cluster.
New in version 21
This function can be used to free the transactions performed on data files found in a HFSQL cluster.
This function can be used to free the transactions performed on data files found in a HFSQL cluster.

Handling records during a transaction

During a transaction, some rules must be complied with when handling the records. See Transactions: Handling records during a transaction for more details.

Transactions and independent HFSQL context

When copying a context, if a transaction is in progress on the first context, the new context is not in transaction. You must call HTransactionStart (or HTransaction) to start a transaction in the new context.

Component: wd260hf.dll