Sftp.GetFileAsync Method
Namespace: Rebex.Net
Assembly: Rebex.Sftp.dll (version 7.0.9083)
GetFileAsync(String, Stream, Object)
Begins asynchronous GetFile operation. Downloads the remote file to the data stream.
Declaration
public Task<long> GetFileAsync(string remotePath, Stream outputStream, object state = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | remotePath | The path of the remote file. |
| Stream | outputStream | The output stream. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Int64> | Number of bytes transferred. |
Implements
GetFileAsync(String, String, Object)
Begins asynchronous GetFile operation. Downloads the remote file to the local file, overriding it if it already exists.
Declaration
public Task<long> GetFileAsync(string remotePath, string localPath, object state = null)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. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Int64> | Number of bytes transferred. |
Implements
GetFileAsync(String, Stream, Int64, Int64, Object)
Begins asynchronous GetFile operation. Downloads the specified part of the remote file to the data stream.
Declaration
public Task<long> GetFileAsync(string remotePath, Stream outputStream, long remoteOffset, long length, object state = null)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. |
| Int64 | length | Number of bytes to transfer or -1 to transfer all data until an end is reached. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Int64> | Number of bytes transferred. |
Remarks
If the local file does not exist, it is created.
GetFileAsync(String, String, Int64, Int64, Int64, Object)
Begins asynchronous GetFile operation. Downloads the specified part of the remote file to the specified offset of the local file.
Declaration
public Task<long> GetFileAsync(string remotePath, string localPath, long remoteOffset, long localOffset, long length, object state = null)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. |
| Int64 | length | Number of bytes to transfer or -1 to transfer until the end is reached. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<Int64> | Number of bytes transferred. |
Remarks
If the local file does not exist, it is created.