SetFileList Method

Sets the file list for a connection during a directory listing request.

Syntax

sftpserver.setFileList(connectionId, list, [callback])

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 this 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

SetFileList should be set when a directory listing is requested by the client. The list parameter should be a string of all the filenames to include, separated by CRLF.