Sftp.IFtp.GetFileAsync Method
Namespace: Rebex.Net
Assembly: Rebex.Sftp.dll (version 7.0.9119)
IFtp.GetFileAsync(String, String, Int64, Int64, Object)
Downloads the specified part of the remote file to the specified offset of the local file.
Declaration
Task<long> IFtp.GetFileAsync(string remotePath, string localPath, long remoteOffset, long localOffset, object state)Parameters
| Type | Name | Description |
|---|---|---|
| String | remotePath | The path of the remote file. |
| String | localPath | The path of the local file. This cannot be a directory. |
| Int64 | remoteOffset | The starting offset of the remote file. |
| Int64 | localOffset | The starting offset in the local file. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Int64> | Number of bytes transferred. |
Implements
Remarks
If the local file does not exist, it is created.
IFtp.GetFileAsync(String, Stream, Int64, Object)
Downloads the specified part of the remote file to the data stream.
Declaration
Task<long> IFtp.GetFileAsync(string remotePath, Stream outputStream, long remoteOffset, object state)Parameters
| Type | Name | Description |
|---|---|---|
| String | remotePath | The path of the remote file. |
| Stream | outputStream | The output stream. |
| Int64 | remoteOffset | The starting offset of the remote file. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Int64> | Number of bytes transferred. |
Implements
Remarks
If the local file does not exist, it is created.