Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbGetRecordLock

Return the record lock status.

Declaration

CTLOCK_MODE ctdbGetRecordLock(CTHANDLE Handle)

Description

ctdbGetRecordLock() retrieves the record lock status.

  • Handle [in] the record handle.

Returns

ctdbGetRecordLock() returns the lock mode of a single record, in particular, CTLOCK_FREE if the record is not locked, CTLOCK_READ if the record has a read lock or CTLOCK_WRITE if the record has a write lock. This works both for records automatically locked with session-wide record locking (see ctdbLock()), and for records manually locked via calls to ctdbLockRecord().

See also

ctdbAllocRecord(), ctdbLockRecord(), ctdbUnlockRecord(), Locking

TOCIndex