Begins asynchronous PutFile operation. Uploads the specified part of the local file to the specified offset of the file on the SFTP server.

Namespace:  Rebex.Net
Assembly:  Rebex.Sftp (in Rebex.Sftp.dll)

Syntax

Visual Basic
Public Function BeginPutFile ( _
	localPath As String, _
	remotePath As String, _
	localOffset As Long, _
	remoteOffset As Long, _
	length As Long, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginPutFile(
	string localPath,
	string remotePath,
	long localOffset,
	long remoteOffset,
	long length,
	AsyncCallback callback,
	Object state
)

Parameters

localPath
Type: System..::..String
The path of the local file.
remotePath
Type: System..::..String
The path of the remote file. This cannot be a directory.
localOffset
Type: System..::..Int64
The starting offset in the local file.
remoteOffset
Type: System..::..Int64
The starting offset of the remote file.
length
Type: System..::..Int64
Number of bytes to transfer or -1 to transfer all data until an end is reached.
callback
Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
state
Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

If the remote file does not exist, it is created.

In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also