Share via


TeamFoundationHostManagementService.StopHost Method

Synchronously stops the service host in all active processes.

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

Syntax

'Declaration
Public Function StopHost ( _
    requestContext As TeamFoundationRequestContext, _
    hostId As Guid, _
    reason As String, _
    timeout As TimeSpan _
) As Boolean
public bool StopHost(
    TeamFoundationRequestContext requestContext,
    Guid hostId,
    string reason,
    TimeSpan timeout
)
public:
virtual bool StopHost(
    TeamFoundationRequestContext^ requestContext, 
    Guid hostId, 
    String^ reason, 
    TimeSpan timeout
) sealed
abstract StopHost : 
        requestContext:TeamFoundationRequestContext * 
        hostId:Guid * 
        reason:string * 
        timeout:TimeSpan -> bool  
override StopHost : 
        requestContext:TeamFoundationRequestContext * 
        hostId:Guid * 
        reason:string * 
        timeout:TimeSpan -> bool
public final function StopHost(
    requestContext : TeamFoundationRequestContext, 
    hostId : Guid, 
    reason : String, 
    timeout : TimeSpan
) : boolean

Parameters

  • reason
    Type: System.String

    An optional reason the host is being stopped.

  • timeout
    Type: System.TimeSpan

    The time to wait for successful completion. TimeSpan.MaxValue is treated as an infinite time-out.

Return Value

Type: System.Boolean
True if the host stopped in the time-out period.

Implements

ITeamFoundationHostManagementService.StopHost(TeamFoundationRequestContext, Guid, String, TimeSpan)

.NET Framework Security

See Also

Reference

TeamFoundationHostManagementService Class

Microsoft.TeamFoundation.Framework.Server Namespace