TeamFoundationBuildService.CancelBuilds Method

Attempts to cancel queued builds with the provided IDs. If the build has already started, is already completed, or does not exist, an exception is thrown.

Namespace:  Microsoft.TeamFoundation.Build.Server
Assembly:  Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)

Syntax

'Declaration
Public Sub CancelBuilds ( _
    requestContext As TeamFoundationRequestContext, _
    queueIds As Integer() _
)

public void CancelBuilds(
    TeamFoundationRequestContext requestContext,
    int[] queueIds
)

public:
void CancelBuilds(
    TeamFoundationRequestContext^ requestContext, 
    array<int>^ queueIds
)

member CancelBuilds : 
        requestContext:TeamFoundationRequestContext * 
        queueIds:int[] -> unit

public function CancelBuilds(
    requestContext : TeamFoundationRequestContext, 
    queueIds : int[]
)

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context for database connection and permissions.

• queueIds
  Type: array<System.Int32[]

  The IDs of the queued builds that should be canceled.

.NET Framework Security

• [M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.ManageBuildQueue] 

  The caller must have ManageBuildQueue permission for the target build definitions.

• [M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.ManageBuildQueue] 

  The caller must have [ManageBuildQueue] permission for the target build definitions.

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

TeamFoundationBuildService Class

Microsoft.TeamFoundation.Build.Server Namespace