SFTP File Controls and VIs
Owning Palette: Toolkit
Requires: LIBSSH2
Represents a SFTP file.
| Class Item | Description |
|---|---|
| Type Definitions | Groups related files into a folder |
| Utility | Groups related files into a folder |
| Read Position | Gets the current position in bytes (B) relative to the beginning of the file. |
| Write Position | Sets the current position within a SFTP File relative to the beginning of the file (0) in bytes (B). |
| Read Size | Gets the total number of bytes (B) for the content in the SFTP File. |
| Close | Deallocates, or frees, the memory allocated for the libssh2lv shared library SFTP File struct represented by this SFTP File object. After this is called, the object can no longer be used in the application without causing a segmentation fault, i.e. crashing LabVIEW. This VI must be called to avoid leaking memory or running Out-of-Memory (OOM) on resource-constrained systems. |
| Open | 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. A SFTP File object represents an existing file on a remote SFTP filesystem. |
| Read Status | Gets the POSIX-style status, a.k.a. attributes, of the remote SFTP file. |
| Read | Reads the contents of a remote SFTP file. |
| Rewind | Sets the current position within the SFTP file to the beginning of the file (0). |
| Sync | Synchronizes the data for the remote SFTP file with the local machine's SFTP file state. |
| Write All | Writes all of the bytes to a remote SFTP file in a series of smaller 30KB chunks, or blocks. |
| Write Status | Sets the POSIX-style file status, a.k.a. attributes, for the remote SFTP file. |
| Write | Writes a libssh2-defined maximum of 30KB to a remote SFTP file. If more the data is greater than 30kB, then the Write All VI should be used. |