SFTP Read File.vi

'SFTP Read File.vi' connector pane

SFTP Read File.vi connector pane

Description

Read a single block of file data from an open SFTP file handle.

SFTP file handle must have been opened already by calling SFTP Open File.vi.

Note

This is a low-level VI. For quick 1-step downloads, use SFTP EZ Receive.vi.

It is not necessary to call this VI when using the “EZ” VIs.

Inputs

cu64 LabSSH Session

Required:Yes

SSH session refnum.

cu32 Count

Required:No
Default:32768

Read up to this amount of bytes from SFTP file handle. This function will not block if the requested byte count is not available.

See Byte Count for the actual amount of bytes read.

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.

i1du8 Data

Contains read file data as a 1-D array of bytes.

iu32 Byte Count

Total number of bytes read.

ierrcodeclst error out

Error (if any) resulting from this VI call.