ILockLockAsync Method

Task LockAsync(
	LockMode lockMode,
	IOperationContext operationContext,
	CancellationToken cancellationToken
)

Function LockAsync ( 
	lockMode As LockMode,
	operationContext As IOperationContext,
	cancellationToken As CancellationToken
) As Task

Task^ LockAsync(
	LockMode lockMode, 
	IOperationContext^ operationContext, 
	CancellationToken cancellationToken
)

abstract LockAsync : 
        lockMode : LockMode * 
        operationContext : IOperationContext * 
        cancellationToken : CancellationToken -> Task 

Parameters

lockMode

Type: ITHit.FileSystemLockMode
Indicates automatic or manual lock.

operationContext

Type: ITHit.FileSystemIOperationContext
Provides information about the environment.

cancellationToken

Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.

Return Value

This method implementation must lock the item in the remote storage and save the received lock-token on the client. You will supply the lock-token as part of your next server update request in WriteAsync(IFileSystemBasicInfo, Stream, IOperationContext, IInSyncResultContext, CancellationToken) and WriteAsync(IFileSystemBasicInfo, IOperationContext, IInSyncResultContext, CancellationToken).

You must also save the lock mode to be returned from GetLockModeAsync(IOperationContext, CancellationToken) method when requested by the Engine.

Reference