ILockGetLockModeAsync Method

Task<LockMode> GetLockModeAsync(
	IOperationContext operationContext,
	CancellationToken cancellationToken
)

Function GetLockModeAsync ( 
	operationContext As IOperationContext,
	cancellationToken As CancellationToken
) As Task(Of LockMode)

Task<LockMode>^ GetLockModeAsync(
	IOperationContext^ operationContext, 
	CancellationToken cancellationToken
)

abstract GetLockModeAsync : 
        operationContext : IOperationContext * 
        cancellationToken : CancellationToken -> Task<LockMode> 

Parameters

operationContext

Type: ITHit.FileSystemIOperationContext
Provides information about the environment.

cancellationToken

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

Return Value

You will return the lock mode passed to LockAsync(LockMode, IOperationContext, CancellationToken) method from this method implementation.

This method is also used to detect if the item is locked. Return None if the item is not locked. The Engine will call LockAsync(LockMode, IOperationContext, CancellationToken) only if this method returns None. The Engine will unlock the item automatically by calling UnlockAsync(IOperationContext, CancellationToken) after update only if this method returns Auto.

Reference