Ping (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Ping (Function)

In french: Ping

Checks whether a network address can be reached by using the ICMP protocol (similar to the PING network utility).

Versions 24 and later

This function is now available for WEBDEV sites in Windows.

New in version 24

This function is now available for WEBDEV sites in Windows.

Versions 27 and later

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for iPhone/iPad applications.

This function is now available in iOS widget mode.

This function is now available in Catalyst mode.

New in version 27

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for iPhone/iPad applications.

This function is now available in iOS widget mode.

This function is now available in Catalyst mode.

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for iPhone/iPad applications.

This function is now available in iOS widget mode.

This function is now available in Catalyst mode.

Example

IF Ping("www.mysite.com") = True THEN
Info("The server is available. You can see the News")
ELSE
Info("Server temporarily unavailable")
END

Syntax

<Result> = Ping(<Address> [, <Maximum duration>])

<Result>: Boolean

True if the sought address is "visible" on the network,
False otherwise. To get more details on the error, use ErrorInfo.

<Address>: Character string

Address for which the network connection must be checked. This IP address can have the following format:
Address in XXX.XXX.XXX.XXX format (125.5.110.100 for example). This syntax is recommended.
DNS address of the computer (www.windev.com for instance).
Address returned by NetIPAddress

<Maximum duration>: Optional integer or optional Duration

Maximum duration allowed to find the address (in milliseconds). This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).
This duration is set to 1000 by default.

Remarks

The Ping function is essentially a network diagnostic tool. It does not guarantee that:

the computer will respond on a given port (to do so, use SocketConnect).
the computer is broken. Indeed, if the ping service is stopped on the computer, this computer will stop responding while it is still operating properly.
the maximum duration will be used to interrupt the function if a network exchange with the server is in progress. For example, the server at the specified address could be contacted and the exchange has already started, but there was no response within the given time. However, if the address cannot be resolved, Ping returns False immediately and does not wait until the maximum duration is elapsed. You can get more details on the error with ErrorInfo.

Business / UI classification: Business Logic

Component: wd270com.dll