ITeamFoundationHostManagementService.PingHostProcess Method

PingHostProcess is used to send a ping request to a process that is operating on this application. This request is sent via a SQL notification. If the process is running correctly and SQL Notifications are being processed the ping should return successfully within a short period of time. If Notifications are being processed via polling or the process has lost connection to the database it may take longer or never complete.

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

Syntax

'Declaration
Function PingHostProcess ( _
    requestContext As TeamFoundationRequestContext, _
    processId As Guid, _
    pingTimeout As TimeSpan _
) As HostProcessPingResponse

HostProcessPingResponse PingHostProcess(
    TeamFoundationRequestContext requestContext,
    Guid processId,
    TimeSpan pingTimeout
)

HostProcessPingResponse^ PingHostProcess(
    TeamFoundationRequestContext^ requestContext, 
    Guid processId, 
    TimeSpan pingTimeout
)

abstract PingHostProcess : 
        requestContext:TeamFoundationRequestContext * 
        processId:Guid * 
        pingTimeout:TimeSpan -> HostProcessPingResponse

function PingHostProcess(
    requestContext : TeamFoundationRequestContext, 
    processId : Guid, 
    pingTimeout : TimeSpan
) : HostProcessPingResponse

Parameters

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

  RequestContextBase to perform the operation

• processId
  Type: System.Guid

  Process to send the ping request too

• pingTimeout
  Type: System.TimeSpan

  Time to wait for the process to respond

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.HostProcessPingResponse
The ping response information on success, null if the ping wasnt successful

.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

ITeamFoundationHostManagementService Interface

Microsoft.TeamFoundation.Framework.Server Namespace