SFTP Read Dir.vi

SFTP Read Dir.vi connector pane

Description

Retrieve metadata of next file in directory.

Directory must have been opened for reading by calling SFTP Open Dir.vi.

An empty string in the File Name member of the Directory Entry Cluster output indicates that there are no more files in this directory.

The process required to list the contents of a directory goes as follows:

1. Call SFTP Open Dir.vi to open the directory for reading.

2. Call SFTP Read Dir.vi repeatedly until it returns an empty filename. An empty filename indicates that all files have been read.

3. Call SFTP Close Dir.vi to close the directory.

Note

This is a low-level VI whose usage is not typical. For a quick 1-step directory listing function, use SFTP EZ Directory Listing.vi.

See also

SFTP Open Dir.vi

SFTP Close Dir.vi

SFTP EZ Directory Listing.vi

Inputs

Localize Time?

Required

No

Default

True

If True , then the File Info member of the output Directory Entry Cluster will convert all timestamp data to the local machine’s timezone. Otherwise, timestamps are GMT.

LabSSH Session

Required

Yes

SSH session refnum.

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.

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

LabSSH Session Out

Duplicate SSH session refnum.

Directory Entry Cluster

Cluster of information pertaining to the file in directory.

Members:

File Name

The name of the file. If an empty string, then there are no more files to be read.

File Info

Contains metadata pertaining to the requested file.

Members:

Size

Size of the file in bytes.

UID

File’s user id.

GID

File’s group owner id.

Permissions

Permissions assigned to file.

Accessed Time

The last-accessed timestamp of the file as reported by the server. If the Localize Time? input is True , then this timestamp uses this machine’s local time zone. Otherwise, it is GMT.

Modified Time

The last-modified timestamp of the file as reported by the server. If the Localize Time? input is True , then this timestamp uses this machine’s local time zone. Otherwise, it is GMT.

File Type [Cluster]

Collection of flags which describe the file type.

Members:

Socket

If True , the file is a socket.

Directory

If True , the file is a directory.

Special Char

If True , the file is a special character file.

Special Block

If True , the file is a special block file.

Symbolic Link

If True , the file is a symbolic link.

Regular

If True , the file is a regular file.

Named Pipe (FIFO)

If True , the file is a named pipe, aka FIFO.

error out

Error (if any) resulting from this VI call.