TElSimpleFTPSClient.GetFileList method

TElSimpleFTPSClient.GetFileList

Returns a list of files in current or specified directory.

Declaration

[C#]
    void GetFileList();
    void GetFileList(string Parameters);
    void GetFileList(string Parameters, TElStringList ResultList);
    void GetFileList(string Parameters, ArrayList ResultList);

[VB.NET]
    Sub GetFileList()
    Sub GetFileList(ByVal Parameters As String)
    Sub GetFileList(ByVal Parameters As String, ByVal ResultList As TElStringList)
    Sub GetFileList(ByVal Parameters As String, ByVal ResultList As ArrayList)

[Pascal]
    procedure GetFileList;
    procedure GetFileList(const Parameters : string);
    procedure GetFileList(const Parameters : string; ResultList : TStringList);
    procedure GetFileList(const Parameters : string; ResultList : TList);

[C++]
    void GetFileList();
    void GetFileList(const std::string &Parameters);
    void GetFileList(const std::string &Parameters, TElStringList &ResultList);
    void GetFileList(const std::string &Parameters, TElStringList *ResultList);
    void GetFileList(const std::string &Parameters, TList &ResultList);
    void GetFileList(const std::string &Parameters, TList *ResultList);

[PHP]
    void GetFileList()
    void GetFileList(string $Parameters)
    void GetFileList(string $Parameters, TElStringList $ResultList)
    void GetFileList(string $Parameters, TList $ResultList)

[Java]
    void getFileList(String Parameters, TElStringList ResultList);
    void getFileList();
    void getFileList(String Parameters, ArrayList ResultList);
    void getFileList(String Parameters);

Parameters

Parameters - (optional) contains a name of remote directory or file to get the listing for. If empty, current directory contents are obtained.
ResultList - Container for the unparsed listing lines (objects), which will be filled by the method (will contain file information).

Description

Use this method to get list of files in current or specified directory. The method executes LIST command of FTP protocol.

During execution of this method the OnTextDataLine event is fired for each line of received reply. Overloaded methods return the listing via ResultList parameter, which can be a list of unparsed response line (the same as in OnTextDataLine event) or a list of TElFTPFileInfo objects.

For a high-level listing method with advanced capabilities see ListDirectory.

Discuss this help topic in SecureBlackbox Forum