UDPGet Function

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help
UDPGet Function
C
BOOL UDPGet(
    BYTE * v
);
Description

This function reads a single byte from the currently active UDP socket, while decrementing the remaining buffer length. UDPIsGetReady should be used before calling this function to specify the currently active socket.

Preconditions

UDPIsGetReady() was previously called to specify the current socket.

Parameters
Parameters 
Description 
The buffer to receive the data being read. 
Return Values
Return Values 
Description 
TRUE 
A byte was successfully read 
FALSE 
No data remained in the read buffer 
Microchip TCP/IP Stack 5.42.08 - June 15, 2013
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.