IFileSystemItemWindowsMoveToCompletionAsync Method |
IT Hit User File System
Called when a file or a folder move or rename operation is completed.
Namespace:
ITHit.FileSystem.Windows
Assembly:
ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 8.3.27213.0
Syntax Task MoveToCompletionAsync(
string targetUserFileSystemPath,
byte[] targetFolderRemoteStorageItemId,
IWindowsMoveContext moveContext,
IInSyncStatusResultContext inSyncResultContext,
CancellationToken cancellationToken = null
)
Function MoveToCompletionAsync (
targetUserFileSystemPath As String,
targetFolderRemoteStorageItemId As Byte(),
moveContext As IWindowsMoveContext,
inSyncResultContext As IInSyncStatusResultContext,
Optional cancellationToken As CancellationToken = Nothing
) As Task
Task^ MoveToCompletionAsync(
String^ targetUserFileSystemPath,
array<unsigned char>^ targetFolderRemoteStorageItemId,
IWindowsMoveContext^ moveContext,
IInSyncStatusResultContext^ inSyncResultContext,
CancellationToken cancellationToken = nullptr
)
abstract MoveToCompletionAsync :
targetUserFileSystemPath : string *
targetFolderRemoteStorageItemId : byte[] *
moveContext : IWindowsMoveContext *
inSyncResultContext : IInSyncStatusResultContext *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task
Parameters
- targetUserFileSystemPath
- Type: SystemString
Target path in the user file system. - targetFolderRemoteStorageItemId
- Type: SystemByte
New parent item ID or null if the ID was never set.
This parameter can also be null if the target folder is not a placeholder
(for example a new folder).
- moveContext
- Type: ITHit.FileSystem.WindowsIWindowsMoveContext
Provides source and target item path. - inSyncResultContext
- Type: ITHit.FileSystemIInSyncStatusResultContext
Provides methods for reporting operation progress and reporting status to the platform.
If the SetInSync property is set to true
the item is marked as in-sync. Otherwise the item
remains in the not in-sync state. The SetInSync property is true by default.
- cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.
Return Value
Type:
TaskA task object that can be awaited.
Remarks
This method is called after you call the ReturnConfirmationResult
method from the MoveToAsync(String, Byte, IOperationContext, IConfirmationResultContext, CancellationToken)
method implementation or if the MoveToAsync(String, Byte, IOperationContext, IConfirmationResultContext, CancellationToken) method completes without exceptions.
This method is NOT called if the ReturnErrorResult(CloudFileStatus) is called from the
MoveToAsync(String, Byte, IOperationContext, IConfirmationResultContext, CancellationToken) or
any exception is thrown inside the MoveToAsync(String, Byte, IOperationContext, IConfirmationResultContext, CancellationToken) method call.
Setting the SetInSync property of the inSyncResultContext
parameter to false
has the same affect as throwing an exception inside this method.
See Also