AppRecord IsLocked() Method

Tests whether the calling AppRecord has been locked, meaning it is in use by another user.

Function Signature

 bool IsLocked( [bool lockedByThisUser] )

Parameters

Parameter	Type	Description
lockedByThisUser	bool	Without an input parameter ( or with "false" as the input ), `IsLocked()` means "Does someone else have this record locked?" With "true" as the input parameter, the meaning is "May I (as the current user) update this record?"

Parameter

Type

Description

lockedByThisUser

bool

Without an input parameter ( or with "false" as the input ), IsLocked() means "Does someone else have this record locked?"

With "true" as the input parameter, the meaning is "May I (as the current user) update this record?"

Return

Type	Description
bool	Returns true if the record is locked by another user.

Technical Details

SBM ModScript version: 11.3.

Example

Notes

IsLocked() should return true if another user is using the item. If the item is locked by the current user who is calling IsLocked(), the return is false, which indicates that no one else can prevent an update to the item that was just locked.