User Tools

Site Tools


Sidebar

en:objects:sftp:files:get_file

get_file

get_file($server,$remote_file,$local_file,$flag_fail_exist=true); - get a file from SFTP to a local disk

The input function accepts parameters:

  • $server – address of an already connected SFTP connection
  • $remote_file – path to the file to download from SFTP
  • $local_file – path to write the file on the local disk
  • $flag_fail_exist – stop the operation if there is such a file on the local disk (true)

    After testing, the function returns the result of its work to the script :
  • true – successfully received
  • false – errors occurred during the receipt

    PHP example:

    <?php $xhe_host = "127.0.0.1:7080";
     
    //connect the object to control the emulator, if not already connected
    if(!isset($path))
      $path = "../../../Templates/xweb_human_emulator.php";
    require($path);
     
    //Start
    echo "<hr> <font color = blue> ftp->".basename(__FILE__)."</font> <hr>";
     
    //sftp account
    $sftp_server = "localhost";
    $login = "test";
    $password = "test";
     
    //1
    echo "1.Connect to server:".$sftp_server.":";
    echo $sftp->connect($sftp_server, $login, $password)."<br>";
     
    //2
    echo "2.Get the file from cftp anyway:";
    echo $sftp->get_file($sftp_server, "/in/test.txt", "test \ get_test.txt", false)."<br>";
     
    //3
    echo "3.Get a file from cftp only if there is no such file on the local machine:";
    if(!$sftp->get_file($sftp_server, "/in/test.txt", "test \ get_test.txt", true))
    echo "already there  n";
     
    //4
    echo "4.Disconnect from all servers:";
    echo $sftp->disconect_all();
     
    //end
    echo "<hr> <br>";
     
    //Quit
    $app->quit();
    ?>

    Python example:

    # Additional paths
    import sys
    sys.path.insert(0, '../../../Templates PY/')
     
    xhe_host = "127.0.0.1:7080"
    from xweb_human_emulator import *
     
    # Start
    echo("<hr> <font color = blue> ftp.xxxxxxxxx </font> <hr>")
     
    # sftp account
    sftp_server = "localhost";
    login = "test";
    password = "test";
     
    # 1
    echo("1.Connect to server:" + sftp_server, ":")
    echo(sftp.connect(sftp_server, login, password), "<br>")
     
    # 2
    echo("2.Let's write the file to the sftp:")
    echo(sftp.put_file(sftp_server, "test \ put_test.txt", "/in/test.txt", false), "<br>")
     
    # 3
    echo("3.We will get the file from the cftp anyway:")
    echo(sftp.get_file(sftp_server, "/in/test.txt", "test \ get_test.txt", false), "<br>")
     
    # 4
    echo("4.Get a file from ftp only if there is no such file on the local machine:")
    if not sftp.get_file(sftp_server, "/in/test.txt", "test \ get_test.txt", true):
    echo("already there
    ")
     
    # five
    echo("5.Disconnect from all servers:")
    echo(sftp.disconnect_all())
     
    # end
    echo("<hr> <br>")
     
    # Quit
    app.quit()

    C# example:

    #region using
     
    using System;
    using System.Diagnostics;
    using System.Collections.Generic;
    using System.Linq;
    using System.IO;
    using System.Text;
    using System.Threading;
     
    using XHE;
    using XHE.XHE_DOM;
    using XHE.XHE_System;
    using XHE.XHE_Window;
    using XHE.XHE_Web;
     
    #endregion
     
     class Program: XHEScript
     {
    static void Main(string [] args)
    {
    //init XHE
    server = "127.0.0.1:7080";
    InitXHE();
     
    //Start
    echo("<hr> <font color = blue> ftp.get_file </font> <hr>");
     
    //sftp account
    string sftp_server = "localhost";
    string login = "test";
    string password = "test";
     
    //1 step
    echo("1.Connect to server:" + sftp_server + ":");
    echo(sftp.connect(sftp_server, login, password) + "<br>");
     
    //step 2
    echo("2.Get the file from ftp anyway:");
    echo(sftp.get_file(sftp_server, "/in/test.txt", "test \ get_test.txt", false) + "<br>");
     
    //step 3
    echo("3.Get a file from ftp only if there is no such file on the local machine:");
    echo(sftp.get_file(sftp_server, "/in/test.txt", "test \ get_test.txt", true) + "<br>");
     
    //step 4
    echo("4.Disconnect from all servers:");
    echo(sftp.disconnect_all());
     
    //end
    echo("<hr> <br>");
     
    app.quit();
    }
    }

    Java Script example:

    //connect the object to control the emulator, if not already connected
    xhe_host = "127.0.0.1:7080";
    echo = require("../../../Templates JS/xweb_human_emulator.js");
     
    //Start
    echo("<hr> <font color = blue> ftp.get_file </font> <hr>");
     
    //sftp account
    sftp_server = "localhost";
    login = "test";
    password = "test";
     
    //1 step
    echo("1.Connect to server:" + sftp_server + ":");
    echo(sftp.connect(sftp_server, login, password) + "<br>");
     
    //step 2
    echo("2.Get the file from sftp anyway:");
    echo(sftp.get_file(sftp_server, "/in/test.txt", "test \ get_test.txt", false) + "<br>");
     
    //step 3
    echo("3.Get a file from cftp only if there is none on the local machine:");
    echo(ftp.get_file(sftp_server, "/in/test.txt", "test \ get_test.txt", true) + "<br>");
     
    //step 4
    echo("4.Disconnect from all servers:");
    echo(sftp.disconnect_all());
     
    //end
    echo("<hr> <br>");
     
    //Quit
    app.quit();
  • en/objects/sftp/files/get_file.txt · Last modified: 2026/08/05 22:47 (external edit)