UDP Open Function

LabVIEW 2018 Help

Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)

LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Owning Palette: UDP VI and Functions

Requires: Base Development System

Opens a UDP socket on the port or service name.

Close the socket with the UDP Close function. Use the UDP Multicast Open VI instead of this function to open connections capable of reading, writing, or reading and writing data to or from UDP Multicast sockets. Use the UDP Write function to query the NI Service Locator for the port number registered with the service name.


net address specifies on which network address to listen. Specifying an address is useful if you have more than one network card, such as two Ethernet cards, and want to listen only on the card with the specified address. If you do not specify a network address, LabVIEW listens on all network addresses. This function broadcasts only on the default network address.

Use the String To IP function to obtain the IP network address of the current computer.

(VxWorks) You cannot send a broadcast from a network card on a target that runs VxWorks and receive the broadcast on that same network card.

(Linux, Mac, VxWorks) If you wire this terminal, you cannot receive broadcasts.
port is the local port with which you want to create a UDP socket.
service name creates a known reference for the port number. If you specify a service name, LabVIEW registers the service name and the port number with the NI Service Locator.
timeout ms specifies the time, in milliseconds, that the function waits before the function completes and returns an error. The default value is 25,000 ms or 25 seconds. 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 is a network connection refnum that uniquely identifies the UDP socket. Use this value to refer to this socket in subsequent VI calls.
port returns the port number the function used. If the input port is not zero, the output port number equals the input port number. Wire 0 to the port input to dynamically choose an available UDP port the operating system determines is valid for use. As defined by the Internet Assigned Numbers Authority (IANA), valid port numbers are between the range of 49152 through 65535. Well Known Ports are between the range of 0 through 1023 and Registered Ports are between the range of 1024 through 49151. Not all operating systems follow the IANA standard; for example, Windows returns dynamic ports between the range of 1024 through 5000.
error out contains error information. This output provides standard error out functionality.


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

  • labview\examples\Data Communication\Protocols\UDP\Simple UDP\Simple UDP.lvproj
  • labview\examples\Data Communication\Protocols\UDP\UDP Named Service\UDP Named Service.lvproj


Not Helpful