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.

Help / WLanguage / Managing databases / HFSQL / Managing transactions / WLanguage functions

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 in the specified data file is considered to be in a transaction, but does not belong to any current transaction, it is automatically freed.

Caution: this is an advanced function. Use this feature when it is not possible to roll back incomplete transactions (e.g. files deleted from a transaction).

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 occurs. HErrorInfo returns more details about the error.

<Data file>: Optional character string

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.

Only the HFSQL Client/Server data files can be 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 occurs. HErrorInfo returns more details about the error.

<Data file>: Optional character string

Name of the HFSQL Classic or HFSQL 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.
Only the HFSQL Client/Server data files can be used.

<Record number>: Integer

Number of the record to be removed.
If this parameter set to 0 or to the hCurrentRecNum constant, HTransactionFree will read 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.
The management of transactions is available for HFSQL Client/Server databases.
This function can be used to free the transactions performed on data files in an HFSQL cluster.

Handling records during a transaction

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

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: wd300hf.dll