Jump to main content

##

# TCPIP_ICMPV6_CallbackRegister Function

## C

    ICMPV6_HANDLE TCPIP_ICMPV6_CallbackRegister(void (*callback)(TCPIP_NET_HANDLE hNetIf, uint8_t type, const IPV6_ADDR * localIP, const IPV6_ADDR * remoteIP, void * header));

## Returns

ICMPV6_HANDLE

- Success - Returns a valid handle
- Failure - Null handle

## Description

This function registers an upper-layer function to handle ICMPv6 messages that may require action at the application layer (Echo Replies, Error messages)

## Remarks

None.

## Preconditions

IPv6 and ICMPv6 are initialized.

## Parameters

Parameters | Description
--- | ---
type | ICMPv6 header type
localIP | IPv6 destination address of the incoming message
remoteIP | IPv6 address of the node that originated the incoming message
header | Pointer to the ICMPv6 header