TCPIP_UDP_Close Function

C

bool TCPIP_UDP_Close(UDP_SOCKET hUDP);

Returns

  • true - If the call succeeded

  • false - If the call failed (no such socket)

Description

Closes a UDP socket and frees the handle. Call this function to release a socket and return it to the pool for use by future communications.

Remarks

Always close the socket when no longer in use. This will free the allocated resources, including the TX buffers.

Preconditions

UDP socket should have been opened with TCPIP_UDP_ServerOpen/TCPIP_UDP_ClientOpen. hUDP - valid socket

Parameters

ParametersDescription
hUDPThe socket handle to be released.