ICacheService.DownloadContainerAsync Method

Definition

Downloads all the container contents, if they are available in a remote cache.

public:
 System::Threading::Tasks::Task ^ DownloadContainerAsync(Microsoft::VisualStudio::RpcContracts::Caching::CacheContainerKey containerKey, IProgress<Microsoft::VisualStudio::RpcContracts::ProgressData ^> ^ progress, System::Threading::CancellationToken cancellationToken);
public System.Threading.Tasks.Task DownloadContainerAsync (Microsoft.VisualStudio.RpcContracts.Caching.CacheContainerKey containerKey, IProgress<Microsoft.VisualStudio.RpcContracts.ProgressData>? progress, System.Threading.CancellationToken cancellationToken);
abstract member DownloadContainerAsync : Microsoft.VisualStudio.RpcContracts.Caching.CacheContainerKey * IProgress<Microsoft.VisualStudio.RpcContracts.ProgressData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function DownloadContainerAsync (containerKey As CacheContainerKey, progress As IProgress(Of ProgressData), cancellationToken As CancellationToken) As Task

Parameters

containerKey
CacheContainerKey

Cache container key that describes the container.

progress
IProgress<ProgressData>

An optional means to receive progress updates on the download operation.

cancellationToken
CancellationToken

Cancellation token to monitor.

Returns

A Task representing the asynchronous operation.

Exceptions

Thrown if cancellationToken is cancelled.

Thrown if this instance has already been disposed.

Thrown when the operation cannot be completed due to a failure in cache storage access.

Thrown when caller has no write permissions.

Applies to