Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / SendFile Method / SendFile(Stream,String,Boolean) Method
A System.IO.Stream whose data is to be sent to the FTP server.
The filename as it will be stored on the FTP server. Cannot be empty. Some FTP servers may be case-sensitive!
true if the file should append itself to the remote file if it already exists; false if the remote file should be overwritten.


In This Topic
    SendFile(Stream,String,Boolean) Method
    In This Topic
    Sends the data from the specified System.IO.Stream to the FTP server's current working folder, indicating if it should append itself to the remote file if it already exists, and stores it using the specified filename.
    Syntax
    'Declaration
 

    Public Overloads Sub SendFile( _
   ByVal source As Stream, _
   ByVal remoteFilename As String, _
   ByVal append As Boolean _
) 
    'Usage
 

    Dim instance As FtpClient
Dim source As Stream
Dim remoteFilename As String
Dim append As Boolean
 
instance.SendFile(source, remoteFilename, append)
    public void SendFile( 
   Stream source,
   string remoteFilename,
   bool append
)

    Parameters

    source
    A System.IO.Stream whose data is to be sent to the FTP server.
    remoteFilename
    The filename as it will be stored on the FTP server. Cannot be empty. Some FTP servers may be case-sensitive!
    append
    true if the file should append itself to the remote file if it already exists; false if the remote file should be overwritten.
    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

    By default, the file will be sent to the current working folder. If you want to send the file to another location, 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.

    When using this overload of the SendFile method, in the SendingFile event, the TransferringFileEventArgs.LocalFilename property will be System.String.Empty. This overload will also ignore the value of the PreAllocateStorage property.

    The SendFile method will send the PASV or PORT and STOR or APPE commands and optionally the TYPE command 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
    System.IO.Stream
    ChangeToParentFolder Method
    SendingFile Event
    LocalFilename Property
    System.String.Empty
    PreAllocateStorage Property

    Send Feedback