Get(String,String,CopyMode) Method

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function Get( _
   ByVal remoteFileName As String, _
   ByVal localFileName As String, _
   ByVal mode As CopyMode _
) As CopyResult

'Usage
 
Dim instance As Sftp
Dim remoteFileName As String
Dim localFileName As String
Dim mode As CopyMode
Dim value As CopyResult
 
value = instance.Get(remoteFileName, localFileName, mode)

public CopyResult Get( 
   string remoteFileName,
   string localFileName,
   CopyMode mode
)

public: CopyResult* Get( 
   string* remoteFileName,
   string* localFileName,
   CopyMode mode
)

public:
CopyResult^ Get( 
   String^ remoteFileName,
   String^ localFileName,
   CopyMode mode
)

Parameters

remoteFileName: An absolute or relative (from WorkingDirectory) path specifying the file on the server. Use "/" as the directory delimiter.
localFileName: An absolute or relative (from the current working directory) path specifying the file on the client.
mode: Specifies the type of copy to perform.

The Progress event is raised as this method executes if an event handler is attached.

If Sftp.ThreadingModel is ThreadingModel.ApartmentAsync, this method immediately returns a null value after starting a worker thread that executes the operation asynchronously. The Progress event is raised containing the result upon completion, or the Error event is raised if an exception is thrown.

The example below demonstrates how to Get a file.

C#

private void button1_Click(object sender, System.EventArgs e)
{
    //Connect and log into the server
    connectAndLogin(myServerHostname, myServerPort, myUsername, myPassword);
    //Download the file
    sftp1.Get(remoteFilename, localSaveLocation, CopyMode.Copy);
    //Logout and close the connection.
    sftp1.Close();
}

private void connectAndLogin(string hostNameOrAddress, int port, string username, string password)
{
    //Connect to the server
    sftp1.Connection.RemoteEndPoint.HostNameOrAddress = hostNameOrAddress;
    sftp1.Connection.RemoteEndPoint.Port = port; //Usually 22
    sftp1.Connect();

    //Authenticate
    SshLoginData loginDetails = new SshLoginData();
    loginDetails.Username = username;
    loginDetails.Password = password;
    sftp1.Authenticate(loginDetails);
}

Visual Basic

Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    'Connect and log into the server
    connectAndLogin(myServerHostname, myServerPort, myUsername, myPassword)
    'Download the file
    sftp1.Get(remoteFilename, localSaveLocation, CopyMode.Copy)
    'Logout and close the connection.
    sftp1.Close()
End Sub

Private Sub connectAndLogin(ByVal hostNameOrAddress As String, ByVal port As Integer, ByVal username As String, ByVal password As String)
    'Connect to the server
    sftp1.Connection.RemoteEndPoint.HostNameOrAddress = hostNameOrAddress
    sftp1.Connection.RemoteEndPoint.Port = port 'Usually 22
    sftp1.Connect()

    'Authenticate
    Dim loginDetails As New SshLoginData()
    loginDetails.Username = username
    loginDetails.Password = password
    sftp1.Authenticate(loginDetails)
End Sub

Reference

Sftp Class
Sftp Members
Overload List