|
Summary
List contents of current directory on server.
Syntax
| Boolean ListDir (Wildcards) |
Description
The ListDir method lists the contents of the current remote directory. The setting of the ListType property or the call to the LongList or the ShortList method determines if a short or a long
listing will be sent. For every entry in the remote directory, the OnList event is fired. If an application does not want to receive any more entries, then it can call the AbortDir method or set the
DirAction property to DIR_ACTION_ABORT in response to this event. Please check the OnList reference page for more information.
The ListDir method takes a Wildcards parameter and returns a boolean. The Wildcards parameter is used to limit the directory entries reported during a directory list operation to
just those files and subdirectories matching the given wildcard expression. Only one wildcard expression, such as "*.TXT", can be specified. It is not possible to specify composite wildcards, such as
"*.EXE *.COM" or "*.* - *.TMP". If the Wildcards parameter is set to an empty string, then all files and subdirectories will be listed. This is identical to setting this parameter to "*.*".
If the contents of the current directory can be successfully listed, then the method returns True; otherwise, it returns False. The application should ensure that the method was successfully executed
by checking the return value. The method also sets the LastResult property. The value of the LastResult property can be checked to determine if any error occurred.
Calling this method is equivalent to setting the DirAction property to DIR_ACTION_LIST.
Example
Result = FTPClient.ListDir ("")
If Result = False Then
MsgBox "Cannot list current directory", 64, "Sample Program"
End If
| 
