TeamFoundationHostManagementService.PingHostProcess Method
Used to send a ping request to a process that is operating on this application. This request is sent by means of an SQL notification. If the process is running correctly and SQL notifications are being processed, the ping should return successfully in a short time. If notifications are being processed by means of polling or the process has lost connection to the database, it may take longer or never finish.
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)
Syntax
'Declaration
Public Function PingHostProcess ( _
requestContext As TeamFoundationRequestContext, _
processId As Guid, _
pingTimeout As TimeSpan _
) As HostProcessPingResponse
public HostProcessPingResponse PingHostProcess(
TeamFoundationRequestContext requestContext,
Guid processId,
TimeSpan pingTimeout
)
public:
HostProcessPingResponse^ PingHostProcess(
TeamFoundationRequestContext^ requestContext,
Guid processId,
TimeSpan pingTimeout
)
member PingHostProcess :
requestContext:TeamFoundationRequestContext *
processId:Guid *
pingTimeout:TimeSpan -> HostProcessPingResponse
public 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.GuidProcess to send the ping request to.
pingTimeout
Type: System.TimeSpanTime to wait for the process to respond.
Return Value
Type: Microsoft.TeamFoundation.Framework.Server.HostProcessPingResponse
The ping response information about success; null if the ping wasn't 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.