IFileSystemProvider.CopyAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.RpcContracts.FileSystem

Assembly:: Microsoft.VisualStudio.RpcContracts.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Copies a file or directory.

public:
 System::Threading::Tasks::Task ^ CopyAsync(Uri ^ sourceUri, Uri ^ destinationUri, bool overwrite, IProgress<Microsoft::VisualStudio::RpcContracts::FileSystem::OperationProgressData> ^ progress, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task CopyAsync (Uri sourceUri, Uri destinationUri, bool overwrite, IProgress<Microsoft.VisualStudio.RpcContracts.FileSystem.OperationProgressData>? progress, System.Threading.CancellationToken cancellationToken);

abstract member CopyAsync : Uri * Uri * bool * IProgress<Microsoft.VisualStudio.RpcContracts.FileSystem.OperationProgressData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CopyAsync (sourceUri As Uri, destinationUri As Uri, overwrite As Boolean, progress As IProgress(Of OperationProgressData), cancellationToken As CancellationToken) As Task

Parameters

sourceUri: Uri

The existing file or directory.

destinationUri: Uri

The new location.

overwrite: Boolean

True to overwrite existing files; otherwise false.

progress: IProgress<OperationProgressData>

The interface through which progress is reported.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task

A task representing the asynchronous copy operation.

Exceptions

ArgumentNullException

sourceUri is null or destinationUri is null.

FileNotFoundException

sourceUri does not exist.

DirectoryNotFoundException

The parent of destinationUri does not exist.

RemoteInvocationException

sourceUri refers to a file, destinationUri already exists and overwrite is false. ErrorCode will be set to FileAlreadyExists.

UnauthorizedAccessException

The caller does not have the required permission.

Remarks

If sourceUri refers to a directory and overwrite is true, destinationUri is removed before the copy is performed. If sourceUri refers to a directory and overwrite is false, the source directory is merged into the existing contents of the destination directory.

Applies to