LockItem(String,Boolean) Method (IDataStorage)

In This Topic

Locks an item in data storage and returns the item.

Syntax

'Declaration

Public Overloads Function LockItem( _
   ByVal keyThe item key.
 As String, _
   ByVal isReadOnlyA value indicating whether the stream must be locked in read-only mode.
 As Boolean _
) As Object

public object LockItem(
   string key, 
   bool isReadOnly
)

public: object* LockItem(
   string* key, 
   bool isReadOnly
)

public:
object^ LockItem(
   string^ key, 
   bool isReadOnly
)

Parameters

key: The item key.
isReadOnly: A value indicating whether the stream must be locked in read-only mode.

Return Value

The locked item from data storage.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if key is null.
System.InvalidOperationException	Thrown if item with specified key is already locked.

Requirements

Target Platforms: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

IDataStorage Interface
IDataStorage Members

UnlockItem(String,Object)
Overload List

Send Feedback