SFTP Open File.vi

'SFTP Open File.vi' connector pane

SFTP Open File.vi connector pane

Description

Open a SFTP file handle.

Inputs

ci32 Permissions

Required

No

Default

640 (octal)

Permissions to assign to remote file if file is being created.

cu64 LabSSH Session

Required

Yes

SSH session refnum.

cstr Remote Path

Required

Yes

Path to remote file. This can be a relative path or an absolute path.

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

ccclst SFTP Open Flags

Required

Yes

Cluster of boolean flags which determine the mode in which the file will be opened.

Members:

cbool Read

If True true, file will be opened in read-mode.

cbool Write

If True true, file will be opened in write-mode.

cbool Create
If True true, file will be created if it doesn’t exist.
If False false and the file doesn’t exist, file will not be opened
and an error will be raised.
cbool Append
If True true, writes will be appended to the end of the file.
If False false writes occur starting at the beginning of the file.
cbool Overwrite
If True true, and the file already exists, it will be overwritten.
If False false and the file already exists, the file will not be opened
and an error will be raised.

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.