Xceed .NET Libraries Documentation
BeginGetRawFolderContents(Boolean,AsyncCallback,Object) Method


Xceed.Ftp Assembly > Xceed.Ftp Namespace > AsyncFtpClient Class > BeginGetRawFolderContents Method : BeginGetRawFolderContents(Boolean,AsyncCallback,Object) Method
true if only filenames should be retrieved; false otherwise.
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Begins the process of retrieving an unprocessed, clear text list representing the entire contents of current working folder as sent by the FTP server and indicates if the entire listing or only filenames should be retrieved. Don't forget to call EndGetRawFolderContents!
Syntax
'Declaration
 
Public Overloads Function BeginGetRawFolderContents( _

   ByVal namesOnly As Boolean, _

   ByVal callback As AsyncCallback, _

   ByVal state As Object _

) As IAsyncResult
'Usage
 
Dim instance As AsyncFtpClient

Dim namesOnly As Boolean

Dim callback As AsyncCallback

Dim state As Object

Dim value As IAsyncResult

 

value = instance.BeginGetRawFolderContents(namesOnly, callback, state)
public IAsyncResult BeginGetRawFolderContents( 

   bool namesOnly,

   AsyncCallback callback,

   object state

)

Parameters

namesOnly
true if only filenames should be retrieved; false otherwise.
callback
Callback method to be called when the asynchronous operation is completed.
state
An object containing state information for this operation.

Return Value

An System.IAsyncResult representing the status of the asynchronous operation.
Remarks

If namesOnly is set to true, the NLST command will be sent to the FTP server and only the name of the items will be returned.If namesOnly is set to false, the LIST command will be sent to the FTP server and all the available information will be returned.

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.

The current working folder can be retrieved via the BeginGetCurrentFolderEndGetCurrentFolder methods.

If you would prefer to receive a processed list of items, you can use the BeginGetRawFolderContents%M:Xceed.Ftp.AsyncFtpClient.EndGetFolderContents(System.IAsyncResult)% methods instead.

The TYPE command will be sent regardless of the value of the FtpClient.SendTypeCommand property when calling the BeginGetRawFolderContents%M:Xceed.Ftp.AsyncFtpClient.EndGetRawFolderContents(System.IAsyncResult)% methods.

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

Requirements

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

See Also

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List