Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / AsyncFtpClient Class / BeginGetUploadStream Method / BeginGetUploadStream(String,Boolean,AsyncCallback,Object) Method
The filename of the file to write to. Some FTP servers may be case-sensitive!
true if existing data should be appended to; false otherwise.
Callback method to be called when the asynchronous operation is completed.
An object containing state information for this operation.
Example


In This Topic
    BeginGetUploadStream(String,Boolean,AsyncCallback,Object) Method
    In This Topic
    Begins the process of retrieving a direct access to the write-only data stream to send to, indicating if existing data should be overwritten or appended to.
    Syntax
    'Declaration
 

    Public Overloads Function BeginGetUploadStream( _
   ByVal remoteFilename As String, _
   ByVal append As Boolean, _
   ByVal callback As AsyncCallback, _
   ByVal state As Object _
) As IAsyncResult
    'Usage
 

    Dim instance As AsyncFtpClient
Dim remoteFilename As String
Dim append As Boolean
Dim callback As AsyncCallback
Dim state As Object
Dim value As IAsyncResult
 
value = instance.BeginGetUploadStream(remoteFilename, append, callback, state)
    public IAsyncResult BeginGetUploadStream( 
   string remoteFilename,
   bool append,
   AsyncCallback callback,
   object state
)

    Parameters

    remoteFilename
    The filename of the file to write to. Some FTP servers may be case-sensitive!
    append
    true if existing data should be appended to; false otherwise.
    callback
    Callback method to be called when the asynchronous operation is completed.
    state
    An object containing state information for this operation.

    Return Value

    An System.IAsyncResult representing the status of the asynchronous operation.
    Remarks

    The FTP client remains in a "SendingFile" state until the stream returned by EndGetUploadStream is closed.

    Example
    AsyncFtpClient ftp = new AsyncFtpClient(); IAsyncResult result = ftp.BeginConnect( "ftp.server.com", null, null ); while( !result.IsCompleted ) Application.DoEvents(); ftp.EndConnect( result ); result = ftp.BeginLogin( null, null ); while( !result.IsCompleted ) Application.DoEvents(); ftp.EndLogin( result ); result = ftp.BeginGetUploadStream( "test.txt", true, null, null ); while( !result.IsCompleted ) Application.DoEvents(); using( System.IO.Stream stream = ftp.EndGetUploadStream( result ) ) { byte[] buffer = System.Text.Encoding.ASCII.GetBytes( "Text written to Ftp in a stream" ); stream.Write( buffer, 0, buffer.Length ); } return; 
    AsyncFtpClient ftp = new AsyncFtpClient();
IAsyncResult result = ftp.BeginConnect( "ftp.server.com", null, null );

while( !result.IsCompleted )
  Application.DoEvents();

ftp.EndConnect( result );

result = ftp.BeginLogin( null, null );

while( !result.IsCompleted )
  Application.DoEvents();

ftp.EndLogin( result );

result = ftp.BeginGetUploadStream( "test.txt", true, null, null );

while( !result.IsCompleted )
  Application.DoEvents();

using( System.IO.Stream stream = ftp.EndGetUploadStream( result ) )
{
  byte[] buffer = System.Text.Encoding.ASCII.GetBytes( "Text written to Ftp in a stream" );
  stream.Write( buffer, 0, buffer.Length );
}

return;
    Example
    AsyncFtpClient ftp = new AsyncFtpClient(); IAsyncResult result = ftp.BeginConnect( "ftp.server.com", null, null ); while( !result.IsCompleted ) Application.DoEvents(); ftp.EndConnect( result ); result = ftp.BeginLogin( null, null ); while( !result.IsCompleted ) Application.DoEvents(); ftp.EndLogin( result ); result = ftp.BeginGetUploadStream( "test.txt", true, null, null ); while( !result.IsCompleted ) Application.DoEvents(); using( System.IO.Stream stream = ftp.EndGetUploadStream( result ) ) { byte[] buffer = System.Text.Encoding.ASCII.GetBytes( "Text written to Ftp in a stream" ); stream.Write( buffer, 0, buffer.Length ); } return;
    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

    AsyncFtpClient Class
    AsyncFtpClient Members
    Overload List
    EndGetUploadStream Method
    System.IAsyncResult

    Send Feedback