ListDir(String,String,Stream) Method

Lists contents of a directory on the server.

[Visual Basic]
Overloads Public Sub ListDir( _
   ByVal RemotePath As String, _
   ByVal ListParams As String, _
   ByVal ToStream As Stream _
) 

[C#]
public void ListDir(
   string RemotePath,
   string ListParams,
   Stream ToStream
);

[JScript]
public function ListDir(
   RemotePath : String,
   ListParams : String,
   ToStream : Stream
);

Parameters

RemotePath

Full path to a directory on the server.

ListParams

Additional parameters for LIST command.

ToStream

Local stream that where wodFtpDLX.NET will write data to.

Remarks

ListDir method will send request to the server to retrieve FULL listing of a directory, given by RemotePath argument. Once server sends data, ListItems event will be fired containing all the files listed by the server - each one in separate line, split by CRLF sequence.

Once completed, Done event will be fired. If no error occurs, Args.Error argument in Done event will be set to null (Nothing in VB). If error occurred, Args.Error will contain description of the error. You can use DirItems property to access parsed collection of items from listed directory.

To get only filenames (and directory names) for specific path, you can use ListNames 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).

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

FtpDLX Class  | FtpDLX Members  | Overload List

© WeOnlyDo Software. All Rights Reserved.