Jump to main content

##

# TCPIP_ICMP_EchoRequestCancel Function

## C

    ICMP_ECHO_RESULT TCPIP_ICMP_EchoRequestCancel(
        TCPIP_ICMP_REQUEST_HANDLE icmpHandle
    );

## Description

This function allows a stack client to cancel a pending ICMP echo request. The request should have been previously scheduled with TCPIP_ICMP_EchoRequest().

## Preconditions

Valid handle obtained using TCPIP_iCMP_EchoReqequest().

## Returns

- ICMP_ECHO_OK - Indicates the cancel request was successful.
- ICMP_ECHO_BAD_HANDLE - No such request is currently scheduled. Invalid handle.

## Remarks

None.