UDP Read Function

LabVIEW 2017 Help

Edition Date: March 2017

Part Number: 371361P-01

»View Product Info
Download Help (Windows Only)

Owning Palette: UDP VI and Functions

Requires: Base Development System

Reads a datagram from a UDP socket, returning the results in data out.

The function returns data when it receives any bytes, and waits the full timeout ms only if it receives no bytes.


connection ID is a network connection refnum that uniquely identifies the UDP socket.
max size is the maximum number of bytes to read. The default is 548. (Windows) If you wire a value other than 548 to this input, Windows might return an error because the function cannot read fewer bytes than are in a packet.
timeout ms specifies the time, in milliseconds, that the function waits for bytes. If no bytes have been received within the specified time, the function completes and returns an error. The default is 25,000 ms. A value of –1 indicates to wait indefinitely.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
connection ID out returns the same value as connection ID.
data out contains the data read from the UDP datagram.
error out contains error information. This output provides standard error out functionality.
port is the port of the UDP socket that sent the datagram.
address is the address of the computer where a datagram originates.


Refer to the following VIs for examples of using the UDP Read function:

  • labview\examples\Data Communication\Protocols\UDP\UDP Multicast\UDP Multicast.lvproj
  • labview\examples\Data Communication\Protocols\UDP\Simple UDP\Simple UDP.lvproj


Not Helpful