Differences
This shows you the differences between the selected revisions of the page.
| scriptcommand_get 2019-07-02 | scriptcommand_get 2024-10-03 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== get ====== | + | ====== get command ====== |
| [[task_download|Downloads]] one or more files from remote directory to local directory. | [[task_download|Downloads]] one or more files from remote directory to local directory. | ||
| - | ===== Syntax ===== | + | ===== [[syntax]] Syntax ===== |
| get <file> [ [ <file2> ... ] <directory>\[ <newname> ] ] | get <file> [ [ <file2> ... ] <directory>\[ <newname> ] ] | ||
| Line 13: | Line 13: | ||
| The last parameter specifies target local directory and optionally [[operation_mask|operation mask]] to store file(s) under different name. Target directory must end with backslash. To download more files to current working directory use ''.\'' as the last parameter. | The last parameter specifies target local directory and optionally [[operation_mask|operation mask]] to store file(s) under different name. Target directory must end with backslash. To download more files to current working directory use ''.\'' as the last parameter. | ||
| + | |||
| + | With the [[commandline#stdout|''/stdout'' command-line switch]], ''-'' can be used as a target to ==stream== the contents of downloaded file(s) to the [[executables#redirection|standard output of ''winscp.com'']]. Streaming is supported with the [[sftp|SFTP]] and [[ftp|FTP]]. | ||
| When specific file name is used, command fails when the file does not exist. When wildcard is used, command succeeds, without doing anything, if the wildcard does not match any file, by default (you can change this using ''[[scriptcommand_option#failonnomatch|option failonnomatch on]]'' command). | When specific file name is used, command fails when the file does not exist. When wildcard is used, command succeeds, without doing anything, if the wildcard does not match any file, by default (you can change this using ''[[scriptcommand_option#failonnomatch|option failonnomatch on]]'' command). | ||
| - | You can have WinSCP [[ui_generateurl|generate a code template]] for ''get'' for you. | + | You can have WinSCP [[guide_automation#generating|generate a code template]] for ''get'' for you. |
| See also ''[[scriptcommand_synchronize|synchronize]]'', if you need to transfer modified or non-existing files only. | See also ''[[scriptcommand_synchronize|synchronize]]'', if you need to transfer modified or non-existing files only. | ||
| Line 26: | Line 28: | ||
| | ''-==delete=='' | Delete source remote file(s) after a successful transfer. | | | ''-==delete=='' | Delete source remote file(s) after a successful transfer. | | ||
| | ''-==latest=='' | Download the latest file from the files selected by the ''file'', ''file2'' ... parameters (typically [[file_mask|file masks]]) only. | | | ''-==latest=='' | Download the latest file from the files selected by the ''file'', ''file2'' ... parameters (typically [[file_mask|file masks]]) only. | | ||
| - | | ''-==resume=='' | Automatically resume transfer if possible·((Applies for individual files transfers only. It does not skip transfer of fully transferred files. For that, combine the switch with ''-neweronly''.)) ([[SFTP]] and [[FTP]] protocols only). Cannot be combined with ''-append''. | | + | | ''-==resume=='' | Automatically resume transfer if possible.((Applies for individual files transfers only. It does not skip transfer of fully transferred files. For that, combine the switch with ''-neweronly''.)) \\ [[SFTP]] and [[FTP]] protocols only. Cannot be combined with ''-append''. Has no effect when streaming (''-'' target). | |
| - | | ''-==append=='' | Append source file to the end of target file ([[sftp|SFTP protocol]] only). Cannot be combined with ''-resume''. | | + | | ''-==append=='' | Append source file to the end of target file. \\ [[sftp|SFTP protocol]] only. Cannot be combined with ''-resume''. Has no effect when streaming (''-'' target). | |
| | ''-==preservetime=='' | Preserve timestamp. | | | ''-==preservetime=='' | Preserve timestamp. | | ||
| | ''-==nopreservetime=='' | Do not preserve timestamp. | | | ''-==nopreservetime=='' | Do not preserve timestamp. | | ||
| Line 33: | Line 35: | ||
| | ''-==transfer===<mode>'' | ''%%binary|ascii|automatic%%'' \\ [[transfer_mode|Transfer mode]]: binary, ascii (text), automatic (by extension). | | | ''-==transfer===<mode>'' | ''%%binary|ascii|automatic%%'' \\ [[transfer_mode|Transfer mode]]: binary, ascii (text), automatic (by extension). | | ||
| | ''-==filemask===<mask>'' | ''%%<mask>[;<mask2>...]%%'' \\ Sets [[file_mask|file mask]]. | | | ''-==filemask===<mask>'' | ''%%<mask>[;<mask2>...]%%'' \\ Sets [[file_mask|file mask]]. | | ||
| - | | ''-==resumesupport===·<state>'' | ''%%on|off|<threshold>%%'' \\ Configures [[resume#automatic|automatic resume/transfer to temporary filename]]. | | + | | ''-==resumesupport===<state>'' | ''%%on|off|<threshold>%%'' \\ Configures [[resume#automatic|automatic resume/transfer to temporary filename]]. | |
| | ''-==neweronly=='' | Transfer new and updated files only. See also ''[[scriptcommand_synchronize|synchronize]]'' command. | | | ''-==neweronly=='' | Transfer new and updated files only. See also ''[[scriptcommand_synchronize|synchronize]]'' command. | | ||
| | ''-==rawtransfersettings== setting1=value1 setting2=value2 ...'' | Allows configuring any transfer settings using [[rawtransfersettings|raw format]] as in an INI file. E.g. to enable preserving of directory timestamps, use ''-rawtransfersettings PreserveTimeDirs=1''. The switch should come only after other parameters. | | | ''-==rawtransfersettings== setting1=value1 setting2=value2 ...'' | Allows configuring any transfer settings using [[rawtransfersettings|raw format]] as in an INI file. E.g. to enable preserving of directory timestamps, use ''-rawtransfersettings PreserveTimeDirs=1''. The switch should come only after other parameters. | | ||
| Line 69: | Line 71: | ||
| ^ Switch ^ Mapping ^ | ^ Switch ^ Mapping ^ | ||
| | ''-delete'' | Value ''true'' (''$True'' in PowerShell) for method parameter ''remove''. | | | ''-delete'' | Value ''true'' (''$True'' in PowerShell) for method parameter ''remove''. | | ||
| - | | ''-latest'' | See [[script_download_most_recent_file|Downloading the most recent file]]. | | + | | ''-latest'' | See [[script_download_most_recent_file|*]]. | |
| | ''-resume'' \\ ''-append'' \\ ''-preservetime'' \\ ''-nopreservetime'' \\ ''-transfer'' \\ ''-filemask'' \\ ''-resumesupport'' \\ ''-speed=<kbps>'' | [[library_from_script_transfer_settings|Converting transfer settings scripting switches]] to .NET assembly class ''TransferSettings''. | | | ''-resume'' \\ ''-append'' \\ ''-preservetime'' \\ ''-nopreservetime'' \\ ''-transfer'' \\ ''-filemask'' \\ ''-resumesupport'' \\ ''-speed=<kbps>'' | [[library_from_script_transfer_settings|Converting transfer settings scripting switches]] to .NET assembly class ''TransferSettings''. | | ||
| | ''-neweronly'' | Not supported. Use ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]'' instead. | | | ''-neweronly'' | Not supported. Use ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]'' instead. | | ||