SFTP EZ Directory Listing.vi

'SFTP EZ Directory Listing.vi' connector pane

SFTP EZ Directory Listing.vi connector pane

Description

List all files in a remote directory and retrieve metadata for every file in the directory.

Inputs

cbool Localize Time?

Required:No
Default:True true

If True true, then File Info member of the output Array of Directory Entries will convert its timestamps to the local machine’s timezone. Otherwise, timestamps are GMT.

cu64 LabSSH Session

Required:Yes

SSH session refnum.

cstr Remote Directory Path

Required:Yes

Remote filesystem path to requested directory. This can be a relative path or an absolute path.

Examples:
/home/user/data/
./data/

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.

i1dcclst Array of Directory Entries

Array of file clusters. Each cluster element represents a file in the directory.

Elements:

icclst Directory Entry Cluster

File entry cluster containing file name and metadata.

Members:

istr File Name
The name of the file.
icclst File Info

Contains metadata pertaining to the requested file.

Members:

iu32 Size
Size of the file in bytes.
iu32 UID
File’s user id.
iu32 GID
File’s group owner id.
iu16 Permissions
Permissions assigned to file.
iatrn Accessed Time
The last-accessed timestamp of the file as reported by the server. If the Localize Time? input is True true, then this timestamp uses this machine’s local time zone. Otherwise, it is GMT.
iatrn Modified Time
The last-modified timestamp of the file as reported by the server. If the Localize Time? input is True true, then this timestamp uses this machine’s local time zone. Otherwise, it is GMT.
icclst File Type [Cluster]

Collection of flags which describe the file type.

Members:

ibool Socket
If True true, the file is a socket.
ibool Directory
If True true, the file is a directory.
ibool Special Char
If True true, the file is a special character file.
ibool Special Block
If True true, the file is a special block file.
ibool Symbolic Link
If True true, the file is a symbolic link.
ibool Regular
If True true, the file is a regular file.
ibool Named Pipe (FIFO)
If True true, the file is a named pipe, aka FIFO.

ii32 Number of Entries

Total number of files found in the directory.

ierrcodeclst error out

Error (if any) resulting from this VI call.