DbiRelRecordLock

C syntax

DBIResult DBIFN DbiRelRecordLock (hCursor, bAll);

Delphi syntax

function DbiRelRecordLock (hCursor: hDBICur; bAll: Bool): DBIResult stdcall;

Description

DbiRelRecordLock releases the record lock on either the current record of hCursor or all the record locks acquired in the current session.

Parameters

hCursor Type: hDBICur (Input)
Specifies the cursor handle.

bAll Type: BOOL (Input)
Specifies which record locks to release. If set to TRUE, all record locks acquired in the current session are released. If set to FALSE, hCursor must be positioned on a record in order to release the lock for that record.

Usage

SQL: Optimistic locks are released by this function. The SQL drivers always perform optimistic record locking; therefore, a record lock request does not explicitly attempt to lock the record on the server.

Completion state

The specified record locks are removed.

DbiResult	Meaning
DBIERR_NONE	Locks were successfully released.
DBIERR_INVALIDHNDL	The specified cursor handle is invalid or NULL.
DBIERR_NOTLOCKED	The current record is not locked (this error is returned only when bAll is FALSE).
DBIERR_NOCURREC	The cursor is not positioned on a record.