BeginGetUploadStream(String,Boolean,AsyncCallback,Object) Method

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

Visual Basic
C#

'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;

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

AsyncFtpClient Class
AsyncFtpClient Members
Overload List