Icmp6SendEcho2 function (icmpapi.h)
The Icmp6SendEcho2 function sends an IPv6 ICMPv6 echo request and returns either immediately (if Event or ApcRoutine is non-NULL) or returns after the specified time-out. The ReplyBuffer contains the IPv6 ICMPv6 echo response, if any.
Syntax
IPHLPAPI_DLL_LINKAGE DWORD Icmp6SendEcho2(
[in] HANDLE IcmpHandle,
[in, optional] HANDLE Event,
[in, optional] PIO_APC_ROUTINE ApcRoutine,
[in, optional] PVOID ApcContext,
[in] sockaddr_in6 *SourceAddress,
[in] sockaddr_in6 *DestinationAddress,
[in] LPVOID RequestData,
[in] WORD RequestSize,
[in, optional] PIP_OPTION_INFORMATION RequestOptions,
[out] LPVOID ReplyBuffer,
[in] DWORD ReplySize,
[in] DWORD Timeout
);
Parameters
[in] IcmpHandle
The open handle returned by Icmp6CreateFile.
[in, optional] Event
An event to be signaled whenever an ICMPv6 response arrives. If this parameter is specified, it requires a handle to a valid event object. Use the CreateEvent or CreateEventEx function to create this event object.
For more information on using events, see Event Objects.
[in, optional] ApcRoutine
The routine that is called when the calling thread is in an alertable thread and an ICMPv6 reply arrives. On Windows Vista and later, PIO_APC_ROUTINE_DEFINED must be defined to force the datatype for this parameter to PIO_APC_ROUTINE rather than FARPROC.
On Windows Server 2003 and Windows XP, PIO_APC_ROUTINE_DEFINED must not be defined to force the datatype for this parameter to FARPROC.
[in, optional] ApcContext
An optional parameter passed to the callback routine specified in the ApcRoutine parameter whenever an ICMPv6 response arrives or an error occurs.
[in] SourceAddress
The IPv6 source address on which to issue the echo request, in the form of a sockaddr structure.
[in] DestinationAddress
The IPv6 destination address of the echo request, in the form of a sockaddr structure.
[in] RequestData
A pointer to a buffer that contains data to send in the request.
[in] RequestSize
The size, in bytes, of the request data buffer pointed to by the RequestData parameter.
[in, optional] RequestOptions
A pointer to the IPv6 header options for the request, in the form of an IP_OPTION_INFORMATION structure. On a 64-bit platform, this parameter is in the form for an IP_OPTION_INFORMATION32 structure.
This parameter may be NULL if no IP header options need to be specified.
[out] ReplyBuffer
A pointer to a buffer to hold replies to the request. Upon return, the buffer contains an ICMPV6_ECHO_REPLY structure followed by the message body from the ICMPv6 echo response reply data. The buffer must be large enough to hold at least one ICMPV6_ECHO_REPLY structure plus the number of bytes of data specified in the RequestSize parameter. This buffer should also be large enough to also hold 8 more bytes of data (the size of an ICMP error message) plus space for an IO_STATUS_BLOCK structure.
[in] ReplySize
The size, in bytes, of the reply buffer pointed to by the ReplyBuffer parameter. This buffer should be large enough to hold at least one ICMPV6_ECHO_REPLY structure plus RequestSize bytes of data. This buffer should also be large enough to also hold 8 more bytes of data (the size of an ICMP error message) plus space for an IO_STATUS_BLOCK structure.
[in] Timeout
The time, in milliseconds, to wait for replies. This parameter is only used if the Icmp6SendEcho2 function is called synchronously. So this parameter is not used if either the ApcRoutine or Event parameter are not NULL.
Return value
When called synchronously, returns the number of replies that are received and stored in ReplyBuffer.
When called asynchronously, indicates that the operation is in progress by returning ERROR_IO_PENDING. You can retrieve the number-of-replies result later, when the event specified in the Event parameter signals, or when the callback function in the ApcRoutine parameter is called.
If the (synchronous or asynchronous) number-of-replies value is zero, then for extended error information call GetLastError.
If the function fails, then the extended error code returned by GetLastError can be one of the following values.
| Return code | Description |
|---|---|
|
This function is not supported on this system. |
|
The data area passed to a system call is too small. This error is returned if the ReplySize parameter indicates that the buffer pointed to by the ReplyBuffer parameter is too small. |
|
One of the parameters is invalid. This error is returned if the IcmpHandle parameter contains an invalid handle. |
|
The operation is in progress. This value is returned by a successful asynchronous call to Icmp6SendEcho2 and is not an indication of an error. |
|
Not enough memory is available to process this command. |
|
The request is not supported. This error is returned if no IPv6 stack is on the local computer. |
|
The size of the ReplyBuffer specified in the ReplySize parameter was too small. |
|
Use FormatMessage to obtain the message string for the returned error. |
Remarks
The Icmp6SendEcho2 function is called synchronously if the ApcRoutine or Event parameters are NULL. When called synchronously, the return value contains the number of replies received and stored in ReplyBuffer after waiting for the time specified in the Timeout parameter. If the return value is zero, call GetLastError for extended error information.
The Icmp6SendEcho2 function is called asynchronously when either the ApcRoutine or Event parameters are specified. When called asynchronously, the ReplyBuffer and ReplySize parameters are required to accept the response. ICMP response data is copied to the ReplyBuffer provided and the application is signaled (when the Event parameter is specified) or the callback function is called (when the ApcRoutine parameter is specified). The application must parse the data pointed to by ReplyBuffer parameter using the Icmp6ParseReplies function.
If the Event parameter is specified, the Icmp6SendEcho2 function is called asynchronously. The event specified in the Event parameter is signaled whenever an ICMPv6 response arrives. Use the CreateEvent function to create this event object.
If the ApcRoutine parameter is specified, the Icmp6SendEcho2 function is called asynchronously. The ApcRoutine parameter should point to a user-defined callback function. The callback function specified in the ApcRoutine parameter is called whenever an ICMPv6 response arrives. The invocation of the callback function specified in the ApcRoutine parameter is serialized.
If both the Event and ApcRoutine parameters are specified, the event specified in the Event parameter is signaled whenever an ICMPv6 response arrives, but the callback function specified in the ApcRoutine parameter is ignored .
On Windows Vista and later, any application that calls Icmp6SendEcho2 function asynchronously using the ApcRoutine parameter must define PIO_APC_ROUTINE_DEFINED to force the datatype for the ApcRoutine parameter to PIO_APC_ROUTINE rather than FARPROC.
On Windows Vista and later, the callback function pointed to by the ApcRoutine must be defined as a function of type VOID with the following syntax:
typedef
VOID WINAPI
(*PIO_APC_ROUTINE) (
IN PVOID ApcContext,
IN PIO_STATUS_BLOCK IoStatusBlock,
IN ULONG Reserved
);
On Windows Vista and later, the parameters passed to the callback function include the following:
On Windows Server 2003 and Windows XP, any application that calls the Icmp6SendEcho2 function asynchronously using the ApcRoutine parameter must not define PIO_APC_ROUTINE_DEFINED to force the datatype for the ApcRoutine parameter to FARPROC rather than PIO_APC_ROUTINE.
On Windows Server 2003 and Windows XP, the callback function pointed to by the ApcRoutine must be defined as a function of type VOID with the following syntax:
typedef
VOID WINAPI
(*FARPROC) (
IN PVOID ApcContext,
);
On Windows Server 2003 and Windows XP, the parameters passed to the callback function include the following:
The callback function specified in the ApcRoutine parameter must be implemented in the same process as the application calling the Icmp6SendEcho2 function. If the callback function is in a separate DLL, then the DLL should be loaded before calling the Icmp6SendEcho2 function.
For IPv4, use the IcmpCreateFile, IcmpSendEcho, IcmpSendEcho2, IcmpSendEcho2Ex, and IcmpParseReplies functions.
Note that the include directive for Iphlpapi.h header file must be placed before the Icmpapi.h header file.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2003 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | icmpapi.h |
| Library | Iphlpapi.lib |
| DLL | Iphlpapi.dll |