Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / GetRawFolderContents Method / GetRawFolderContents(Boolean) Method
true if only filenames should be retrieved; false otherwise.


In This Topic
    GetRawFolderContents(Boolean) Method
    In This Topic
    Retrieves 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.
    Syntax
    'Declaration
 

    Public Overloads Function GetRawFolderContents( _
   ByVal namesOnly As Boolean _
) As StringList
    'Usage
 

    Dim instance As FtpClient
Dim namesOnly As Boolean
Dim value As StringList
 
value = instance.GetRawFolderContents(namesOnly)
    public StringList GetRawFolderContents( 
   bool namesOnly
)

    Parameters

    namesOnly
    true if only filenames should be retrieved; false otherwise.

    Return Value

    A reference to a StringList collection contain a list of unprocessed strings each representing an item folder. 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
    ExceptionDescription
    FtpInvalidStateExceptionCannot perform the requested operation because the FTP client is in an invalid state.
    FtpReplyExceptionAn error reply was returned by the FTP server.
    FtpIOExceptionAn I/O error has occurred.
    FtpInternalExceptionA fatal FTP-specific error has occurred..
    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 GetRawFolderContents and/or ChangeToParentFolder methods to change the current working folder.

    The current working folder can be retrieved via the GetCurrentFolder method.

    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.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

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

    Send Feedback