XNET Close
- Updated2023-02-17
- 2 minute(s) read
XNET Close
Clears (closes) the XNET session.
Inputs/Outputs
session in
The session to clear. This session is selected from the LabVIEW project or returned from XNET Create Session.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
error out
Error information.
The node produces this output according to standard error behavior.
Description
This node stops communication for the session and releases all resources the session uses. XNET Close internally calls XNET Stop with normal scope, so if this is the last session using the interface, communication stops.
When your application is finished (the top-level node is idle), LabVIEW automatically clears all XNET sessions within that node and its leaf nodes. Therefore, XNET Close is rarely needed in your application.
You typically use XNET Close when you need to clear the existing session to create a new session that uses the same objects. For example, if you create a session for a frame named frameA using Frame Output Single-Point mode, then you create a second session for frameA using Frame Output Queued mode, the second call to XNET Create Session returns an error, because frameA can be accessed using only one output mode. If you call XNET Clear before the second XNET Create Session call, you can close the previous use of frameA to create the new session.
This node disconnects terminals that you connected using the XNET Connect Terminals node.