IPWorks EDI 2020 Node.js Edition

Questions / Feedback?

ListDirectory Method

List the current directory specified by RemotePath on an SFTP server.

Syntax

sftp.listDirectory([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

A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The file listing is received through the DirList event.

If there is no SSH session in place, one is automatically created by the component first.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 Node.js Edition - Version 20.0 [Build 8203]