LockItem(String,Boolean) Method (StreamDataStorage)

In This Topic

Locks the stream in data storage and returns the locked stream.

Syntax

'Declaration

Public Overloads Function LockItem( _
   ByVal keyThe stream filename or file URL.
 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 stream filename or file URL.
isReadOnly: A value indicating whether the stream must be locked in read-only mode.

Return Value

The stream, which was opened in read-write mode and without ability to share the file.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if key is null or empty.

Remarks

Method creates a file if file does not exist.

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

StreamDataStorage Class
StreamDataStorage Members

Overload List

Send Feedback