Jump to main content

##

# TCPIP_UDP_SocketInfoGet Function

## C

    bool TCPIP_UDP_SocketInfoGet(UDP_SOCKET hUDP, UDP_SOCKET_INFO* pInfo);

## Returns

- true - if the call succeeded
- false - if no such socket or invalid pInfo

## Description

This function will fill a user passed UDP_SOCKET_INFO structure with current status of the selected socket.

## Preconditions

UDP socket should have been opened with TCPIP_UDP_ServerOpen()/TCPIP_UDP_ClientOpen()(). hUDP - valid socket pInfo -valid address of a UDP_SOCKET_INFO structure

## Parameters

Parameters | Description
--- | ---
UDP_SOCKET | hUDP Socket for which information is to be obtained
UDP_SOCKET_INFO* | pInfo pointer to UDP_SOCKET_INFO to receive socket information