c - What is the full function of TCPIP_TCP_ArrayGet of Harmony Configurator? -

i read docs of tcpip module of harmony configurator it's lacking of documentation , wanna know if knows complete/detailed functionality of tcpip_tcp_arrayget function. please me out , kind me cause i'm newbie here on stackoverflow , on project i'm working on. thanks

documentation tcpip_tcp_arrayget reads array of data bytes tcp socket's rx buffer/fifo. data removed fifo in process.

uint16_t tcpip_tcp_arrayget( tcp_socket htcp, uint8_t* buffer, uint16_t* count );

precondition tcp initialized

parameters htcp - socket data read. buffer - pointer array store data read. len - number of bytes read.

returns number of bytes read socket. if less len, rx fifo buffer became empty or socket not connected.

thanks help.