IClientNotificationsUnlockAsync Method |
IT Hit User File System
Unlocks the file in the remote storage.
Namespace:
ITHit.FileSystem.Windows
Assembly:
ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 8.3.27213.0
Syntax Task<OperationResult> UnlockAsync(
bool unlockWriteBlockedFile = true,
CancellationToken cancellationToken = null
)
Function UnlockAsync (
Optional unlockWriteBlockedFile As Boolean = true,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of OperationResult)
Task<OperationResult^>^ UnlockAsync(
bool unlockWriteBlockedFile = true,
CancellationToken cancellationToken = nullptr
)
abstract UnlockAsync :
?unlockWriteBlockedFile : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _unlockWriteBlockedFile = defaultArg unlockWriteBlockedFile true
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<OperationResult>
Parameters
- unlockWriteBlockedFile (Optional)
- Type: SystemBoolean
Unlock the file if it is write blocked.
Set this parameter to true when calling from the file manager context menu.
Set to false when calling from synchronization service, because
you do not want to unlock files that are being opened for writing.
- cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.
Return Value
Type:
TaskOperationResultOperation result, indicating if the operation was successfull and how many items was affected. If operation failed contains reason for the failure.
Exceptions Exception | Condition |
---|
ClientLockFailedException |
Thrown when a file can not be unlocked. For example when update, lock, unlock operation is in progress.
|
See Also