Difference between revisions of "Retrieve file.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Normalise sequential blank lines)
m (Rename Arguments section heading to Parameters)
Line 6: Line 6:
 
         file_path=retrieve_file(file_url,file_name,dest_dir)
 
         file_path=retrieve_file(file_url,file_name,dest_dir)
  
−
==Arguments==
+
==Parameters==
  
 
         file_url  - HTTPS URL pointing to the file to retrieve
 
         file_url  - HTTPS URL pointing to the file to retrieve

Revision as of 18:51, 5 June 2026

Retrieves a file from an HTTPS link and stores it in a user-specified directory.

Syntax

        file_path=retrieve_file(file_url,file_name,dest_dir)

Parameters

        file_url  - HTTPS URL pointing to the file to retrieve
        file_name - name of the file to be stored on disk
        dest_dir  - destination directory for the downloaded file

Outputs

        file_path - full path to the retrieved file

Examples

See examples in the Spinach distribution relevant to this function.

Notes

This page was generated from the function header in the Spinach repository.

See also

Version 2.11, authors: Ilya Kuprov