IBuildService.StartBuildOperationAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.RpcContracts.Build

Assembly:: Microsoft.VisualStudio.RpcContracts.dll

Package:: Microsoft.VisualStudio.RpcContracts v17.12.12

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.

Invokes the BuildAction on a list of buildable items.

public:
 System::Threading::Tasks::Task<Microsoft::VisualStudio::RpcContracts::Build::BuildOperationResult ^> ^ StartBuildOperationAsync(Microsoft::VisualStudio::RpcContracts::Build::BuildAction buildAction, Guid operationId, System::Collections::Generic::IReadOnlyList<System::String ^> ^ buildableIds, IProgress<int> ^ progress, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<Microsoft.VisualStudio.RpcContracts.Build.BuildOperationResult> StartBuildOperationAsync (Microsoft.VisualStudio.RpcContracts.Build.BuildAction buildAction, Guid operationId, System.Collections.Generic.IReadOnlyList<string> buildableIds, IProgress<int> progress, System.Threading.CancellationToken cancellationToken);

abstract member StartBuildOperationAsync : Microsoft.VisualStudio.RpcContracts.Build.BuildAction * Guid * System.Collections.Generic.IReadOnlyList<string> * IProgress<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.RpcContracts.Build.BuildOperationResult>

Public Function StartBuildOperationAsync (buildAction As BuildAction, operationId As Guid, buildableIds As IReadOnlyList(Of String), progress As IProgress(Of Integer), cancellationToken As CancellationToken) As Task(Of BuildOperationResult)

Parameters

buildAction: BuildAction

The BuildAction to be executed.

operationId: Guid

A unique identifier for the operation.

buildableIds: IReadOnlyList<String>

The Id of BuildableItems to be built.

progress: IProgress<Int32>

The build progress in percentage.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<BuildOperationResult>

The completion task with a BuildOperationResult.

Exceptions

ArgumentException

Thrown if the caller passes an unrecognized buildable id.

Remarks

Available only in version BuildService.

Applies to

Share via