Framework EDI Reference. Methods and Properties
ediTransports. Ping

Pings a remote server.

Syntax:

• <lRetval> = object.Ping(<sServerName>, [<lTimeout>], [<lPingSize>])

Parameters:

• sServerName – Name or IP Address of remote server to ping.
• lTimeout - Optional.  Duration of time to wait for echo response from remote server.  Defaults to 3000 (3 seconds).
• lPingSize - Optional.  Size of outgoing data packet in bytes.  Defaults to 32 bytes.

Returns

Returns 1 if an echo was received from the remote server; otherwise 0 is returned.

Remarks

This method tests for IP-level connectivity with a remote server.  It sends a small data packet -- an Echo Request -- to the remote server, and, if the server receives the request, it sends data back -- an Echo Reply -- in response.  The ICMP protocol is used in the communication.

The Time-To-Live (TTL) for each outgoing data packet is currently set to 128.

Example

Dim oEdiDoc As Fredi.ediDocument
Dim oTransports As Fredi.ediTransports
Dim sServerName As String

' Create instance of Framework EDI.
Set oEdiDoc = New Fredi.ediDocument

' Get transports object
Set oTransports = oEdiDoc.GetTransports

' Remote server address.
sServerName = "192.168.1.100"

' Ping remote server.
If oTransports.Ping(sServerName) = 1 Then

MsgBox "Can connect with remote server " & sServerName

Else

MsgBox "Cannot connect with remote server " & sServerName

End If

Samples

• M_Ping.zip