Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / GetDownloadStream Method / GetDownloadStream(String) Method
The filename of the file to retrieve. Some FTP servers may be case-sensitive!


In This Topic
    GetDownloadStream(String) Method
    In This Topic
    Retrieves a direct access to the readonly data stream being received.
    Syntax
    'Declaration
     
    
    Public Overloads Function GetDownloadStream( _
       ByVal remoteFilename As String _
    ) As Stream
    'Usage
     
    
    Dim instance As FtpClient
    Dim remoteFilename As String
    Dim value As Stream
     
    value = instance.GetDownloadStream(remoteFilename)
    public Stream GetDownloadStream( 
       string remoteFilename
    )

    Parameters

    remoteFilename
    The filename of the file to retrieve. Some FTP servers may be case-sensitive!

    Return Value

    The data System.IO.Stream to read from.
    Remarks

    The FTP client will remain in a "ReceivingFile" state until the stream is closed.

    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