SCP Init Receive.vi

SCP Init Receive.vi connector pane

Description

Initialize an SCP file download channel.

This will instruct the server to initiate the file transfer.

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

Localize Time?

Required

No

Default

True

If True , then the file’s File Info timestamp data is converted to the local machine timezone.

LabSSH Session

Required

Yes

SSH session refnum.

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

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.

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

LabSSH Session Out

Duplicate SSH session refnum.

File Info

Contains metadata pertaining to the downloaded file.

Members:

Size

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

Permissions

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

Modified Time

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

Accessed Time

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

Byte Count

Size in bytes of downloaded file.

error out

Error (if any) resulting from this VI call.