BuildControllerWebService.StopBuild Method

Called to stop a given build. The failureMessage parameter contains the error that occurs when the build is stopped.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function StopBuild ( _
    buildUri As String, _
    <OutAttribute> ByRef failureMessage As String _
) As Boolean

[WebMethodAttribute]
public bool StopBuild(
    string buildUri,
    out string failureMessage
)

[WebMethodAttribute]
public:
bool StopBuild(
    String^ buildUri, 
    [OutAttribute] String^% failureMessage
)

[<WebMethodAttribute>]
member StopBuild : 
        buildUri:string * 
        failureMessage:string byref -> bool

public function StopBuild(
    buildUri : String, 
    failureMessage : String
) : boolean

Parameters

• buildUri
  Type: System.String

• failureMessage
  Type: System.String%

Return Value

Type: System.Boolean

.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

BuildControllerWebService Class

Microsoft.TeamFoundation.Build.Server.Compatibility Namespace