AdvantageCMS.Core.Common.BaseClasses Namespace
Build With Advantage

AdvantageLockEngine..::..Client_ObjectLock Method

Attempts to lock the specified object for the given user. If the object is already locked by another session, the lock will not be acquired.

Namespace:  AdvantageCMS.Core.Common.Engine
Assembly:  AdvantageCMS.Core (in AdvantageCMS.Core.dll)

Syntax


public LockStatus Client_ObjectLock(
	string userLockKey,
	Guid masterId,
	string userName
)

Parameters

userLockKey
Type: String
The unique key identifying the user lock session.
masterId
Type: Guid
The identifier of the master object to lock.
userName
Type: String
The name of the user requesting the lock.

Return Value

A LockStatus indicating whether the lock was acquired or if the object is locked by another session.