CL Stream Accept CL Stream Connect navigation bar

Table of Contents >Quanser Rapid Control Prototyping Toolkit >VI and Function Reference >VIs - By Category >VI Categories >Communication VIs and Functions >Advanced >

CL Stream Close

CL Stream Close

Owning Palette:Communications/Advanced

Requirements:Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer, Control Design and Simulation Module

Description

The CL 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 CL Stream Connect, CL Stream Listen or CL Stream Accept VIs.

Required Inputs All required inputs must be wired. They always appear as terminals on the VI palette. They also appear in bold text in the context help window for the VI.
stream in

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

Outputs

error out 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 icon status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.
code icon 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 icon source identifies where an error occurred. The source string is usually the name of the VI that produced the error.

Details

The CL 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 CL Stream Connect, CL Stream Listen or CL Stream Accept VIs.

Feedthrough Behaviour

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

Examples

  		•  RCP CL Comm Advanced Stream Example

    See Also

  		•  CL Stream Accept The CL Stream Accept VI accepts a connection from a remote host.
  		• CL Stream Connect

    The CL Stream Connect VI establishes a connection to a remote host. The connection is made each time the VI executes.

  		• CL Stream Flush The CL Stream Flush VI writes the data in the stream buffer to the underlying communication channel.
  		• CL Stream Listen The CL Stream Listen VI creates a stream that listens for connections from remote hosts.
  		• CL Stream PollThe CL Stream Poll VI polls for events associated with the connected stream.

    Targets

    Target

    Supported

    Comments

    RCP Windows (64-bit) Target

    Yes

    Fully supported.

     

    navigation bar

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

    Link to this page.