SH Read.vi

'SH Read.vi' connector pane

SH Read.vi connector pane

Description

Read all available characters from shell channel.

Shell channel must have been initialized by calling SH Request.vi.

New in version 2.6: This VI accepts a timeout value of 0, which prevents timeout errors from occurring if no data is available. This is the recommended way to poll for data.

Inputs

cu64 LabSSH Session

Required:Yes

SSH session refnum.

cerrcodeclst error in

Required:No
Default:No Error

Incoming error from previous VI call. Is passed through to error out.

Warning

LabVIEW will not execute Call Library Function Node if there is an error present on the wire. Ensure that there is no error prior to calling this VI – unexpected behavior will occur.

ci32 Timeout msec

Required:No
Default:5000

Amount of time in milliseconds to wait for a response from remote host before a timeout error occurs.

Outputs

iu64 LabSSH Session Out

Duplicate SSH session refnum.

istr Data

String data received from shell instance.

Note

Some servers will inlcude terminal-emulation control characters for changing text color, background color, etc. These will appear as unreadable characters, and it is up to the programmer remove these. LabSSH will not attempt any filtering of data.

iu32 Byte Count

Number of bytes successfully read.

ierrcodeclst error out

Error (if any) resulting from this VI call.