TCPIP_IPV4_PacketHandlerDeregister Function

C

bool TCPIP_IPV4_PacketHandlerDeregister(
    TCPIP_IPV4_PROCESS_HANDLE pktHandle
);

Description

This function removes a packet processing handler.

Preconditions

IPv4 properly initialized.

Parameters

ParametersDescription
pktHandleTCPIP packet handle obtained by a call to TCPIP_IPV4_PacketHandlerRegister().

Returns

  • True - If the operation succeeded.

  • False - If the operation failed.

Remarks

Exists only if TCPIP_IPV4_EXTERN_PACKET_PROCESS is true.

Example

TCPIP_IPV4_PROCESS_HANDLE myHandle = TCPIP_IPV4_PacketHandlerRegister(myPacketHandler, myParam );
// process incoming packets
// now we're done with it
TCPIP_IPV4_PacketHandlerDeregister(myHandle);