Product Documentation

c-treeDB API for C++ - Developers Guide

Previous Topic

Next Topic

CTBase::IsLockActive

Syntax

CTBOOL IsLockActive ( )

Parameters

This method has no parameters.

Description

Indicates whether a session wide lock is active. A session wide lock is a lock that has been started with a call to Lock, with one of the READ, WRITE, and RESTORE mode variations, but not terminated with a call to Unlock or Lock with the mode parameter as FREE or SUSPEND.

IsLockActive() does not indicate if record lock is active. Record lock is one that is obtained with a call to CTRecord::LockRecord().

Return

IsLockActive() returns YES if the session wide lock is active and NO otherwise.

See also

Lock(), Unlock(), GetLockMode(), IsTransActive()

TOCIndex