PingHost Method

Pings a host.

Syntax

ping.pingHost(host, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method will ping a host. A valid internet domain name or address must be specified in Host, or an error will be returned.

PING request (ICMP ECHO) is sent to Host.

Example (Ping a Host)

PingControl.PingHost("MyHostName")
ResponseTime = PingControl.ResponseTime