Skip to main content

Save file

Saves the file from the server to the specified path

Function SaveFile(Val Connection, Val Path, Val FileName) Export

ParameterCLI optionTypeRequiredDescription
Connection--connArbitrary✔Existing connection or connection configuration
Path--pathString✔Path to file on server
FileName--fileString✔Path to save file on disk

Returns: Map Of KeyAndValue - Processing result


tip

FTP Command: RETR


1C:Enterprise/OneScript code example
    Host     = "172.33.0.10";
    Port     = "21";
    Login    = "bayselonarrend";
    Password = "12we...";

    UseProxy = True;
    FTPS     = True;

    ProxySettings = Undefined;
    TLSSettings   = Undefined; // FTPS

    FTPSettings = OPI_FTP.GetConnectionSettings(Host, Port, Login, Password);

    If UseProxy Then

        ProxyType = "http"; // http, socks5, socks4

        ProxyAddress  = "127.0.0.1";
        ProxyPort     = "8071";
        ProxyLogin    = "proxyuser";
        ProxyPassword = "12we...";

        ProxySettings = OPI_FTP.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);

    EndIf;

    If FTPS Then
        TLSSettings = OPI_FTP.GetTLSSettings(True);
    EndIf;

    Connection = OPI_FTP.CreateConnection(FTPSettings, ProxySettings, TLSSettings);

    If OPI_FTP.IsConnector(Connection) Then

        Path     = "new_dir/big.bin";
        FileName = GetTempFileName("bin");

        Result = OPI_FTP.SaveFile(Connection, Path, FileName);

    Else
        Result = Connection; // Error of connection
    EndIf;
    oint ftp SaveFile \
     --conn "{'set':{'advanced_resolve':true,'domain':'172.33.0.11','login':'bayselonarrend','passive':true,'password':'***','port':'21','read_timeout':'120','write_timeout':'120'},'tls':{'accept_invalid_certs':true,'ca_cert_path':null,'use_tls':true},'proxy':{'login':'proxyuser','password':'***','port':'1080','proxy_type':'socks5','server':'127.0.0.1'}}" \
     --path "new_dir/big.bin" \
     --file "/tmp/5jyjbrpc.mjb.bin"
Result
{
 "bytes": 335944730,
 "filepath": "/tmp/5jyjbrpc.mjb.bin",
 "result": true,
 "close_connection": {
  "result": true
 }
}