Closes a TCP network connection.


icon

Inputs/Outputs

  • cgenclassrn.png socket —

    socket is a network connection refnum that uniquely identifies the connection.

  • cbool.png abort (F) —

    abort (F) specifies whether to abort the TCP session immediately or stay open until any remaining data is sent. When abort is false (default), after returning from XNET TCP Socket Close.vi, the TCP connection stays open in the background while any remaining data is sent, and then closes after handshake. When abort is true, the TCP connection is immediately aborted (reset) and closed (regardless of unsent data), and XNET TCP Socket Close.vi returns.

  • cerrcodeclst.png error in —

    The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

  • ierrcodeclst.png error out —

    The error out cluster passes error or warning information out of a VI to be used by other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

    • Description

    When XNET IP Stack Clear.vi is called to close the stack, all TCP connections must be aborted in order to free stack resources. Therefore, setting abort to false for XNET TCP Socket Close.vi is applicable only when you intend to leave the stack running.