Table of Contents

Stream Close

Owning Palette:

Not available in this version of RCP Toolkit. Please check for updates.

Requirements:

Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer

---

Description

---

The Stream Close VI closes the stream. The stream may not be used after it has been closed. The connection is closed each time the VI executes. If this VI is used in a periodic task then it should be part of a state machine that only invokes it for a valid stream. This VI is not affected by the blocking mode of the stream. It may be used to close streams created by the Stream Connect, Stream Listen or Stream Accept VIs.

---

Required Inputs All required inputs must be wired. They appear in bold text in the context help window for the VI.

---

stream in is a reference to the stream to be closed.

---

Recommended Inputs Recommended inputs need not be wired. They appear as simple text in the context help window for the VI.

---

error in describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster in error out. status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations. code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description. source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

---

Outputs

---

error out contains error information. If the error in cluster indicated an error, the error out cluster contains the same information. Otherwise, error out describes the error status of this VI. status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations. code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description. source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

---

Feedthrough Behaviour

---

All input/output pairs of this function have direct feedthrough behaviour.

---

Examples

---

RCP CL Comm Advanced Stream Example

---

See Also

---

	Stream Accept	The Stream Accept VI accepts connection from a remote host.
	Stream Connect	The Stream Connect VI establishes a connection to a remote host. The connection is made each time the VI executes.
	Stream Flush	The Stream Flush VI flushes a stream created using Stream Connect or Stream Listen.
	Stream Listen	The Stream Listen VI creates a stream that listens for connections from remote hosts.

---

Targets

Target	Supported	Comments
RCP Windows (64-bit) Target	Yes	Fully supported.

 

Copyright © Quanser Inc. This page was generated 2021-09-24. Submit feedback to Quanser about this page.

Link to this page.