Documentation » .NET Assembly » Session Class »

Session.GetFile Method

Provides System.IO.Stream interface to a remote file contents.

For an efficient download to a physical local file, use Session.GetFileToDirectory and similar methods instead.

Syntax
- Parameters
- Return Value
Remarks

Syntax

public System.IO.Stream GetFile(
    string remoteFilePath,
    TransferOptions options = null
)

VB.NET

Public Function GetFile(
    remoteFilePath As String,
    Optional options As TransferOptions = Nothing
) As System.IO.Stream

Parameters

Name	Description
string remoteFilePath	Full path to the remote file to retrieve.
TransferOptions options	Transfer options. Defaults to `null`, what is an equivalent to `new TransferOptions()`.

Return Value

System.IO.Stream implementation that can be used to read the remote file contents. It implements the Read and Dispose methods only, and other methods derived from these two, like Close and CopyTo. Seeking and cancelling the transfer is not supported. Calling the Dispose (or the Close) will finish downloading the file.