<Source>.UnlockFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

ErrorStatusModification

FilterIncludedBetween

MigrateLinkedCompositeKey

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.UnlockFile (Function)

In french: <Source>.DébloqueFichier

Not available with these kinds of connection

Unlocks the records of a data file:

locked by <Source>.LockFile.
individually locked by a locking read function.

The data file can also be unlocked by closing it (<Source>.Close).

Remark: <Source>.UnlockFile cannot be used to unlock a data file locked by another session or by another program. We advise you to unlock a data file as soon as possible in order for the other sessions to be able to access this data file.

This function can be used with HFSQL Client/Server data files.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 19 and later

This function is now available for Java applications.

New in version 19

This function is now available for Java applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

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

Example

// Lock
Customer.LockFile(hLockReadWrite)
// Modify the file
...
// Unlock
Customer.UnlockFile()

Syntax

<Result> = <Source>.UnlockFile()

<Result>: Boolean

True if the data file was unlocked,
False if a problem occurred (the data file is not locked, ...). HError is used to identify the error.

<Source>: Type corresponding to the specified source

Name of data file used.

Remarks

<Source>.UnlockFile has no effect if:

the data file is in single-user mode (see <Source>.Mode).
the data file is not locked.
the data file was locked by another program.

Component: wd260hf.dll