<Source>.TransactionFree (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Managing databases

Managing transactions

WLanguage functions

Prefix syntax

TransactionFree

Presentation

Example

See also

<Source>.TransactionFree (Function)

In french: <Source>.TransactionLibè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).

Example

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

Syntax

Freeing a data file Hide the details

<Result> = <Source>.TransactionFree()

<Result>: Boolean

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

<Source>: Type corresponding to the specified source

Name of the HFSQL Classic or Client/Server data file for which the records in transaction must be freed.

Only the HFSQL Client/Server data files can be used.

Freeing a record found in a data file Hide the details

<Result> = <Source>.TransactionFree(<Record number>)

<Result>: Boolean

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

<Source>: Type corresponding to the specified source

Name of the HFSQL Classic or HFSQL Client/Server data file for which the record in transaction must be freed.
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, <Source>.TransactionFree 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 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 <Connection variable>.TransactionStart (or <Connection variable>.Transaction) to start a transaction in the new context.

Component: wd280hf.dll