GetRawFolderContents(String,Boolean) Method

Retrieves an unprocessed, clear text list representing the contents of the current working folder as sent by the FTP server and indicates if the entire listing or only filenames should be retrieved.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetRawFolderContents( _
   ByVal remoteFileMask As String, _
   ByVal namesOnly As Boolean _
) As StringList

'Usage
 
Dim instance As FtpClient
Dim remoteFileMask As String
Dim namesOnly As Boolean
Dim value As StringList
 
value = instance.GetRawFolderContents(remoteFileMask, namesOnly)

public StringList GetRawFolderContents( 
   string remoteFileMask,
   bool namesOnly
)

Parameters

remoteFileMask: The file mask of the remote files to retrieve. This parameter can 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!
namesOnly: true if only filenames should be retrieved; false otherwise.

Return Value

A reference to a StringList collection containing a list of unprocessed strings each representing a file matched by . For example: "07-25-03 11:46AM 101 001fdf63.xml". Of course, the format of the strings returned by the FTP server can vary from server to server.

Exceptions

Exception	Description
FtpInvalidStateException	Cannot perform the requested operation because the FTP client is in an invalid state.
FtpReplyException	An error reply was returned by the FTP server.
FtpIOException	An I/O error has occurred.
FtpInternalException	A fatal FTP-specific error has occurred..

Remarks

If you want to retrieve the contents of another folder, you could use the ChangeCurrentFolder and/or ChangeToParentFolder 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 GetCurrentFolder method.

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 all the available information will be returned.

If you would prefer to receive a processed list of items, you can use the GetFolderContents method instead.

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

The GetRawFolderContents method will send the LIST or NLST and PASV or PORT and TYPE commands to the FTP server.

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

Reference

FtpClient Class
FtpClient Members
Overload List
Xceed.Ftp.FtpClient.GetFolderContents(Xceed.Ftp.Engine.FtpCommandChannel,Xceed.Ftp.Engine.ListFtpCommand)