TCPIP_STACK_PacketHandlerDeregister Function
C
bool TCPIP_STACK_PacketHandlerDeregister(
TCPIP_NET_HANDLE hNet,
TCPIP_STACK_PROCESS_HANDLE pktHandle
);
Description
This function removes a packet processing handler.
Preconditions
The TCP/IP stack should have been initialized by TCPIP_STACK_Initialize() and the TCPIP_STACK_Status() returned SYS_STATUS_READY.
Parameters
| Parameters | Description |
|---|---|
| hNet | Network handle. |
| pktHandle | TCP/IP packet handle obtained by a call to TCPIP_STACK_PacketHandlerRegister(). |
Returns
- True - If the operation succeeded.
- False - If the operation failed.
Remarks
Exists only if TCPIP_STACK_EXTERN_PACKET_PROCESS() is true.
Example
TCPIP_STACK_PROCESS_HANDLE myHandle = TCPIP_STACK_PacketHandlerRegister( hNet, myPacketHandler, myParam );
// process incoming packets
// now we're done with it
TCPIP_STACK_PacketHandlerDeregister(hNet, myHandle);
