IcmpSendEcho Function  
 
INT WINAPI IcmpSendEcho(
  HCLIENT hClient  
);

The IcmpSendEcho function sends an ICMP echo datagram to the remote host.

Parameters

hClient
A handle to the client session.

Return Value

If the function succeeds, the return value is zero. If the function fails, the return value is ICMP_ERROR. To get extended error information, call IcmpGetLastError.

Remarks

For asynchronous client sessions, this function returns immediately. Otherwise, the client enters a blocking state and waits for a reply from the remote host. The function returns when a reply has been received, or the operation times-out.

Requirements

Client: Requires Windows 7, Windows Vista or Windows XP.
Server: Requires Windows Server 2008 or Windows Server 2003.
Header: Include cstools7.h.
Library: Use csicmav7.lib.
Unicode: Implemented as Unicode and ANSI versions.

See Also

IcmpEcho, IcmpGetSendCount, IcmpRecvEcho, IcmpSetSequenceId, IcmpSetTimeToLive, IcmpTraceRoute