SCP Receive.vi

'SCP Receive.vi' connector pane

SCP Receive.vi connector pane

Description

Receive a single block of file data from an open SCP download channel.

SCP download channel must have been initialized already by calling SCP Init Receive.vi.

Note

This is a low-level VI whose usage is not typical. For quick 1-step downloads, use SCP 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 Bytes to Read

Required

No

Default

32768

Read up to this amount of bytes from SCP download channel. If requested number of bytes are not available, this functions reads what is available and returns immediately without blocking. 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

1-D array of byte data, which represents the file being downloaded. It is up to the programmer to process this data (e.g. writing to local file).

iu32 Byte Count

Total number of bytes transferred.

ierrcodeclst error out

Error (if any) resulting from this VI call.