Waits for an accepted TCP network connection.

![]() |
listener ID in is a network connection refnum that uniquely identifies the listener. | ||||||
![]() |
resolve remote address indicates whether to call the IP To String function on the remote address. The default is TRUE. Refer to IP To String for more information. | ||||||
![]() |
timeout ms is the period of time in milliseconds to wait for a connection. If a connection is not established in the specified time, the function returns an error. The default value is –1, which indicates to wait indefinitely. | ||||||
![]() |
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
| ||||||
![]() |
listener ID out has the same value as listener ID in. Use this value to refer to the listener in subsequent calls to this function. | ||||||
![]() |
remote address is the address of the remote machine associated with the TCP connection. This address is in IP dot notation format. | ||||||
![]() |
remote port is the port the remote system uses for the connection. | ||||||
![]() |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
| ||||||
![]() |
connection ID is a network connection refnum that uniquely identifies the TCP connection. Use this value to refer to this connection in subsequent VI calls. |
Refer to the following VIs for examples of using the TCP Wait On Listener function: