This function sends an Internet Control Message Protocol (ICMP) echo request, and returns one or more replies.
At a Glance
| Header file: | Icmpapi.h |
| Windows CE versions: | 2.0 and later |
Syntax
DWORD WINAPI IcmpSendEcho (HANDLE IcmpHandle
IPAddr DestinationAddress LPVOID RequestData WORD RequestSize PIP_OPTION_INFORMATION RequestOptions LPVOID ReplyBuffer DWORDReplySize DWORD Timeout);
Parameters
IcmpHandle
[in] ICMP handle opened by IcmpCreateFile.
DestinationAddress
[in] Specifies the destination of the echo request.
RequestData
[in] Buffer that contains the data to be sent in the request.
RequestSize
[in] Number of bytes in the RequestData buffer.
RequestOptions
[in] Pointer to the IP header options for the request; may be NULL.
ReplyBuffer
[out] Buffer to hold any replies to the request. When the function returns, the buffer will contain one or more ICMP_ECHO_REPLY structures, followed by options and data.
ReplySize
[out] Size, in bytes, of the reply buffer. The buffer must be large enough to accommodate at least one ICMP_ECHO_REPLY structure plus eight additional bytes (the size of an ICMP error message).
Timeout
[in] Time, in milliseconds, to wait for replies.
Return Values
The number of replies received and stored in the reply buffer indicates success. Zero indicates failure. Extended error information is available through GetLastError.
See Also