Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / GetRawFolderContents Method / GetRawFolderContents(String) Method
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!


In This Topic
    GetRawFolderContents(String) Method
    In This Topic
    Retrieves an unprocessed, clear text list representing the contents of the current working folder as sent by the FTP server.
    Syntax
    'Declaration
 

    Public Overloads Function GetRawFolderContents( _
   ByVal remoteFileMask As String _
) As StringList
    'Usage
 

    Dim instance As FtpClient
Dim remoteFileMask As String
Dim value As StringList
 
value = instance.GetRawFolderContents(remoteFileMask)
    public StringList GetRawFolderContents( 
   string remoteFileMask
)

    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!

    Return Value

    A reference to a StringList collection containing a list of unprocessed strings each representing a file matched by remoteFileMask. 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 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 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 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