'Declaration
 
Public Overloads Function BeginGetFolderContents( _

   ByVal remoteFileMask As String, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult

'Usage
 
Dim instance As AsyncFtpClient

Dim remoteFileMask As String

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginGetFolderContents(remoteFileMask, callback, state)

public IAsyncResult BeginGetFolderContents( 

   string remoteFileMask,

   AsyncCallback callback,

   object state

)

Parameters

remoteFileMask

The file mask of the remote files to retrieve. This parameter can include a filtering mask to limit the files that are retrieved. For example, if System.String.Empty is specified, the entire contents of the current working folder will be retrieved. If "*.txt" is used, all the files in the current working folder that have the TXT extension will be retrieved. Some FTP servers may be case-sensitive!

callback

Callback method to be called when the asynchronous operation is completed.

state

An object containing state information for this operation.

Return Value

If you want to retrieve the contents of another folder, you could use the BeginChangeCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeCurrentFolder(System.IAsyncResult)% methods and/or BeginChangeToParentFolder%M:Xceed.Ftp.AsyncFtpClient.EndChangeToParentFolder(System.IAsyncResult)% methods to change the current working folder. Absolute paths can also be provided, however some FTP servers might not support absolute paths and different server types may have different ways of representing absolute paths.

The current working folder can be retrieved via the BeginGetCurrentFolder%M:Xceed.Ftp.AsyncFtpClient.EndGetCurrentFolder(System.IAsyncResult)% methods.

The listing lines can be manually parsed or modified via the FtpClient.ParsingListingLine event.

If you would prefer to receive an unprocessed list of items, you can use the BeginGetRawFolderContents(String,Boolean,AsyncCallback,Object)%M:Xceed.Ftp.AsyncFtpClient.EndGetRawFolderContents(System.IAsyncResult)% methods instead.

The TYPE command will be sent regardless of the value of the FtpClient.SendTypeCommand property when calling the BeginGetFolderContents method.

When using a callback, the System.IAsyncResult is provided as a parameter. You should call EndGetFolderContents in that callback. When NOT providing a callback, you should keep the returned IAsyncResult and call EndGetFolderContents with it when ready to complete. In this later case, the call to EndGetFolderContents may block until the operation completes.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List