LockItem Method

In This Topic

Gets called when an item of the repository is loaded to be edited (i.e. project files) to lock it for exclusive access.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Function LockItem( _
   ByVal id As String _
) As Boolean

bool LockItem( 
   string id
)

bool LockItem( 
   String^ id
)

Parameters

id: ID of the repository item to lock.

Return Value

Return false in case the item is already locked by an other user (no blocking lock!), or true if the lock was acquired or is not needed.

Remarks

Usually other users should not be able to edit the item at the same time. It is advisable to implement a fallback in case UnlockItem does not get called (e.g. due to an error).

Requirements

Platforms: Windows 10 (Version 21H2 - 23H2), Windows 11 (21H2 - 22H2), Windows Server 2016 - 2022
.NET: .NET Framework 4.8, .NET 6, .NET 7, .NET 8

Reference

IRepository Interface
IRepository Members

Send Feedback