SCP EZ Receive.vi

'SCP EZ Receive.vi' connector pane

SCP EZ Receive.vi connector pane

Description

Perform a 1-step SCP file download.

Changed in version 2.4: This function is now a pure-LabVIEW implementation. Prior to 2.4, this function called into a DLL function which would block the entire application and render the UI unusable until the download completed.

In 2.4, this function uses a pure-LabVIEW file transfer loop using low-level file transfer functions, so the application remains responsive, i.e. doesn’t appear frozen when transferring large files.

Inputs

cbool Localize Time?

Required

No

Default

True true

If True true, then the file’s File Info timestamp members in the output cluster File Info are converted to the local machine timezone. Otherwise, all times are in GMT.

cu64 LabSSH Session

Required

Yes

SSH session refnum.

cpath Local Path

Required

Yes

Local system path to which downloaded file will be written.

If this file exists, it will be overwritten.

cstr Remote Path

Required

Yes

Remote filesystem path to requested file. This can be a relative path or an absolute path.

Examples
/home/user/data/data1.txt
./data/data1.txt

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.

icclst File Info

Contains metadata pertaining to the downloaded file.

Members:

iu32 Size

The size of the transferred file as reported by the server.

iu16 Permissions

The permissions of the downloaded file as reported by the server.

iatrn Modified Time

The last-modified timestamp of the file as reported by the server. If the Localize Time? input is True true, then this timestamp uses this machine’s local time zone. Otherwise, it is GMT.

iatrn Accessed Time

The last-accessed timestamp of the file as reported by the server. If the Localize Time? input is True true, then this timestamp uses this machine’s local time zone. Otherwise, it is GMT.

iu32 Byte Count

Size in bytes of downloaded file.

ierrcodeclst error out

Error (if any) resulting from this VI call.