Back to product page

ListNames method


Lists names in the directory on the server.

Type

None

Syntax

  • Basic
object.ListNames[RemotePath]
The ListNames(object,RemotePath) syntax has these parts:
objectAn expression evaluating to an object of type wodFtpDLX.
RemotePathOptional. A Variant value. Full path to a directory on the server.

Remarks

ListNames method will send request to the server to retrieve only names of files and directories in the given path. Once server sends data, ListItems event will be fired containing all the file listed by the server - each one in separate line, split by CRLF sequence. If item is a directory, wodFtpDLX will append / (slash) to the end of it.

Once completed, Done event will be fired. If no error occurs, ErrorCode argument in Done event will be set to 0 (zero). If error occurred, ErrorCode will hold number for the error, and ErrorText will contain description for the error.

To retrieve full listing of files/directories on a given path (including size, permissions, dates...) you should use ListDir method.

No wildcards can be used for RemotePath argument. RFC protocol specification for SFTP does not allow them.

Do not forget that RemotePath should always specify full absolute path (i.e. /home/joe/something) instead of relative path (i.e. joe/something).

Platforms

Windows