<Source>.UnlockRecNum (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.UnlockRecNum (Function)

In french: <Source>.DébloqueNumEnr

Not available with these kinds of connection

Unlocks a record locked by:

the <Source>.LockRecNum function,
a read function used with a locking parameter (for example, <Source>.Read used with the hLockWrite or hLockReadWrite constant).

Note: The <Source>.UnlockRecNum function cannot be used to unlock a recording blocked by another application.

This function is available for HFSQL data files only. It is not available for the data files accessed by JDBC.

Example

// Lock
Customer.LockRecNum(hRecNumCurrent, hLockReadWrite)
// Modify the record
...
// Unlock
Customer.UnlockRecNum(hRecNumCurrent)

Syntax

<Result> = <Source>.UnlockRecNum([<Record number>])

<Result>: Boolean

True if the record was unlocked,
False if a problem occurs. HError is used to identify the error.

<Source>: Type corresponding to the specified source

Name of the data file used.

<Record number>: Optional integer

Number of the record to unlock.
If this number is not specified (or is equal to 0 or to the hCurrentRecNum constant), <Source>.UnlockRecNum will read the current record.
<Source>.UnlockRecNum unlocks the current record only. You cannot specify a record number other than the current one (to specify the current record number, use the hRecNumCurrent constant).

Remarks

<Source>.UnlockRecNum has no effect if:

The data file is in single-user mode (see <Source>.Mode).
The record is not locked.

Component: wd300hf.dll