Open VI

Owning Palette: SFTP File

Requires: LIBSSH2

Creates a new SFTP File object that represents a libssh2lv shared library SFTP File struct. This VI must be called, or executed, before using any other SFTP File-related VIs. This VI allocates memory within the libssh2lv shared library that must be explicitly deallocated, or freed, at the end of the application using the Close VI to avoid memory leaks or running Out-of-Memory (OOM) on a resource contrained system.

SFTP

Creates a new SFTP File object from a SFTP object.

	Options is a series of boolean values that customize the execution of the file open operation. For example, if the Read option is TRUE, then the remote SFTP file will be opened with the read permission. The Append forces all writes to append data to the end of the file, while the Truncate value forces an existing file with the same remote path to be truncated to zero length. The Create value will indicate a new file should be created if one does not already exist. The Exclude value indicates to skip an operation if a file already exists.
	Permissions is the UNIX-like filesystem permissions, also known as the filesystem entry's "mode". A filesystem entry's permissions, or mode, are divided into three categorizes: Owner, Group, and Other, where each category can have a Read, Write, or Execute permission.
	SFTP File represents a libssh2lv shared library SFTP File struct.
	Remote Path is a path on the remote SSH server where a new file will be opened or created. The path separator of the remote filesystem should be used. For example, a forwardslash, "/", should be used if the remote SSH server is a UNIX-like system, while a backslash, "\", should be used if the remote SSH server is a DOS-like system.
	SFTP represents a libssh2lv shared library SFTP struct.
	Error Out contains error information. This provides standard error out functionality. Right-click the Error Out indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.
	Error In describes error conditions that occur before this node runs. This input provides standard error in functionality. Right-click the Error In indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.