Share via


ICodeContainerProvider.AcquireCodeContainerAsync Method

Definition

Overloads

AcquireCodeContainerAsync(IProgress<ServiceProgressData>, CancellationToken)

Acquires an online code container locally.

AcquireCodeContainerAsync(CodeContainer, IProgress<ServiceProgressData>, CancellationToken)

Acquires a previously known online code container locally.

An example of a previously known code container is for a given signed in user, a code container that was acquired on one device and available as an online code container on a second device and available for reacquisition.

AcquireCodeContainerAsync(IProgress<ServiceProgressData>, CancellationToken)

Acquires an online code container locally.

public:
 System::Threading::Tasks::Task<Microsoft::VisualStudio::Shell::CodeContainer ^> ^ AcquireCodeContainerAsync(IProgress<Microsoft::VisualStudio::Shell::ServiceProgressData ^> ^ downloadProgress, System::Threading::CancellationToken cancellationToken);
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.CodeContainer> AcquireCodeContainerAsync (IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData> downloadProgress, System.Threading.CancellationToken cancellationToken);
abstract member AcquireCodeContainerAsync : IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.CodeContainer>
Public Function AcquireCodeContainerAsync (downloadProgress As IProgress(Of ServiceProgressData), cancellationToken As CancellationToken) As Task(Of CodeContainer)

Parameters

downloadProgress
IProgress<ServiceProgressData>

Reports download progress. If this value is null, no download progress will be reported.

cancellationToken
CancellationToken

A cancellation token to cancel the operation.

Returns

A task the returns a code container that has been acquired locally. If the task is faulted, the exception will be recorded in the VS activity log.

Applies to

AcquireCodeContainerAsync(CodeContainer, IProgress<ServiceProgressData>, CancellationToken)

Acquires a previously known online code container locally.

An example of a previously known code container is for a given signed in user, a code container that was acquired on one device and available as an online code container on a second device and available for reacquisition.

public:
 System::Threading::Tasks::Task<Microsoft::VisualStudio::Shell::CodeContainer ^> ^ AcquireCodeContainerAsync(Microsoft::VisualStudio::Shell::CodeContainer ^ onlineCodeContainer, IProgress<Microsoft::VisualStudio::Shell::ServiceProgressData ^> ^ downloadProgress, System::Threading::CancellationToken cancellationToken);
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.CodeContainer> AcquireCodeContainerAsync (Microsoft.VisualStudio.Shell.CodeContainer onlineCodeContainer, IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData> downloadProgress, System.Threading.CancellationToken cancellationToken);
abstract member AcquireCodeContainerAsync : Microsoft.VisualStudio.Shell.CodeContainer * IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.CodeContainer>
Public Function AcquireCodeContainerAsync (onlineCodeContainer As CodeContainer, downloadProgress As IProgress(Of ServiceProgressData), cancellationToken As CancellationToken) As Task(Of CodeContainer)

Parameters

onlineCodeContainer
CodeContainer

The online code container to acquire.

downloadProgress
IProgress<ServiceProgressData>

Reports download progress. If this value is null, no download progress will be reported.

cancellationToken
CancellationToken

A cancellation token to cancel the operation.

Returns

A task the returns a code container that has been acquired locally. If the task is faulted, the exception will be recorded in the VS activity log.

Applies to