Api.TryGetLock method

Explicitly reserve the ability to update a row, write lock, or to explicitly prevent a row from being updated by any other session, read lock. Normally, row write locks are acquired implicitly as a result of updating rows. Read locks are usually not required because of record versioning. However, in some cases a transaction may desire to explicitly lock a row to enforce serialization, or to ensure that a subsequent operation will succeed.

Namespace:  Microsoft.Isam.Esent.Interop
Assembly:  Microsoft.Isam.Esent.Interop (in Microsoft.Isam.Esent.Interop.dll)

Syntax

'Declaration
Public Shared Function TryGetLock ( _
    sesid As JET_SESID, _
    tableid As JET_TABLEID, _
    grbit As GetLockGrbit _
) As Boolean
'Usage
Dim sesid As JET_SESID
Dim tableid As JET_TABLEID
Dim grbit As GetLockGrbit
Dim returnValue As Boolean

returnValue = Api.TryGetLock(sesid, _
    tableid, grbit)

public static bool TryGetLock(
    JET_SESID sesid,
    JET_TABLEID tableid,
    GetLockGrbit grbit
)

Parameters

• sesid
  Type: Microsoft.Isam.Esent.Interop.JET_SESID

  The session to use.

• tableid
  Type: Microsoft.Isam.Esent.Interop.JET_TABLEID

  The cursor to use. A lock will be acquired on the current record.

• grbit
  Type: Microsoft.Isam.Esent.Interop.GetLockGrbit

  Lock options, use this to specify which type of lock to obtain.

Return value

Type: System.Boolean
True if the lock was obtained, false otherwise. An exception is thrown if an unexpected error is encountered.

See also

Reference

Api class

Api members

Microsoft.Isam.Esent.Interop namespace