SCP Init Send.vi

'SCP Init Send.vi' connector pane

SCP Init Send.vi connector pane

Description

Initialize an SCP file upload channel.

This will instruct the server to prepare to receive the file.

Note

This is a low-level VI whose usage is not typical. For quick 1-step downloads, use SCP EZ Send.vi.

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

Inputs

ci32 Permissions

Required:No
Default:640 (octal)

Permissions to assign remote file.

cu64 LabSSH Session

Required:Yes

SSH session refnum.

cstr Remote Path

Required:Yes

Path to remote file. Uploaded file will be written here. This can be a relative path or an absolute path.

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

cu32 Size

Required:Yes

Size of file in bytes. The server must know in advance how many bytes to expect.

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.

ierrcodeclst error out

Error (if any) resulting from this VI call.