VsShellUtilities.DownloadFileAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

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.

Caution

Use IFileSystem.DownloadFileAsync instead. This API will go away in 16.10.

Caution

Use IFileSystem.DownloadFileAsync instead

Downloads a remote file if it has not already been downloaded.

public:
 static System::Threading::Tasks::Task<Uri ^> ^ DownloadFileAsync(Uri ^ remoteUri, IProgress<Microsoft::VisualStudio::RpcContracts::FileSystem::OperationProgressData> ^ progress, System::Threading::CancellationToken cancellationToken);

[System.Obsolete("Use IFileSystem.DownloadFileAsync instead.  This API will go away in 16.10.")]
public static System.Threading.Tasks.Task<Uri> DownloadFileAsync (Uri remoteUri, IProgress<Microsoft.VisualStudio.RpcContracts.FileSystem.OperationProgressData>? progress, System.Threading.CancellationToken cancellationToken);

[System.Obsolete("Use IFileSystem.DownloadFileAsync instead", true)]
public static System.Threading.Tasks.Task<Uri> DownloadFileAsync (Uri remoteUri, IProgress<Microsoft.VisualStudio.RpcContracts.FileSystem.OperationProgressData>? progress, System.Threading.CancellationToken cancellationToken);

[<System.Obsolete("Use IFileSystem.DownloadFileAsync instead.  This API will go away in 16.10.")>]
static member DownloadFileAsync : Uri * IProgress<Microsoft.VisualStudio.RpcContracts.FileSystem.OperationProgressData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Uri>

[<System.Obsolete("Use IFileSystem.DownloadFileAsync instead", true)>]
static member DownloadFileAsync : Uri * IProgress<Microsoft.VisualStudio.RpcContracts.FileSystem.OperationProgressData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Uri>

Public Function DownloadFileAsync (remoteUri As Uri, progress As IProgress(Of OperationProgressData), cancellationToken As CancellationToken) As Task(Of Uri)

Parameters

remoteUri: Uri

The URI of the file to download.

progress: IProgress<OperationProgressData>

The interface through which progress is reported (optional).

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<Uri>

The URI of the local file.

Attributes: ObsoleteAttribute

Remarks

If the provider does not support IRemoteFileSystemProvider, remoteUri is returned.

Applies to

Share via