DirListFileName Property

This property shows the file name in the last directory listing.

Syntax

 sftp.getDirListFileName(index, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDirListFileName([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setDirListFileName([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property shows the file name in the last directory listing. This may also be the directory name if a directory is being listed. You can tell whether it is a file or directory by the boolean DirListIsDir property.

The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

String