BuildService.CancelBuilds Method

Cancels builds currently in the queue that are either in the Postponed or Active state. The user performing the cancel must have the administer build permission on the team project in order to complete successfully.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Sub CancelBuilds ( _
    ids As Integer() _
)

[WebMethodAttribute]
public void CancelBuilds(
    int[] ids
)

[WebMethodAttribute]
public:
void CancelBuilds(
    array<int>^ ids
)

[<WebMethodAttribute>]
member CancelBuilds : 
        ids:int[] -> unit

public function CancelBuilds(
    ids : int[]
)

Parameters

• ids
  Type: array<System.Int32[]

  The IDs of queued builds that should be canceled.

.NET Framework Security

• 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

BuildService Class

Microsoft.TeamFoundation.Build.Server.Compatibility Namespace