Differences
This shows you the differences between the selected revisions of the page.
| library_session_putfilestodirectory 2020-02-18 | library_session_putfilestodirectory 2022-07-20 (current) | ||
| Line 27: | Line 27: | ||
| ==== Parameters ==== | ==== Parameters ==== | ||
| ^ Name ^ Description ^ | ^ Name ^ Description ^ | ||
| - | | string ==localDirectory== | Full path to the remote directory to download the files from. | | + | | string ==localDirectory== | Full path to the local directory to upload the files from. | |
| - | | string ==remoteDirectory == | Full path to the local directory to download the files to. | | + | | string ==remoteDirectory == | Full path to the remote directory to upload the files to. | |
| | string ==filemask== | Windows wildcard ((The Windows wildcard supports ''*'' and ''?'' only. If you want to use a full syntax of [[file_mask|file masks]], use a ''[[library_transferoptions#filemask|TransferOptions.FileMask]]''.)) to select the files or subdirectories to upload. Defaults to ''null'' to upload all files and subdirectories of the local directory. | | | string ==filemask== | Windows wildcard ((The Windows wildcard supports ''*'' and ''?'' only. If you want to use a full syntax of [[file_mask|file masks]], use a ''[[library_transferoptions#filemask|TransferOptions.FileMask]]''.)) to select the files or subdirectories to upload. Defaults to ''null'' to upload all files and subdirectories of the local directory. | | ||
| | bool ==remove== | When set to ''true'', deletes the source local file(s) after a successful transfer. Defaults to ''false''. | | | bool ==remove== | When set to ''true'', deletes the source local file(s) after a successful transfer. Defaults to ''false''. | | ||
| Line 44: | Line 44: | ||
| | TimeoutException | Timeout waiting for ''winscp.com'' to respond. | | | TimeoutException | Timeout waiting for ''winscp.com'' to respond. | | ||
| - | ===== Remarks ===== | + | ===== [[remarks]] Remarks ===== |
| - | Event ''[[library_session_filetransferred|Session.FileTransferred]]'' is raised for every uploaded file. | + | Event ''[[library_session_filetransferred|Session.FileTransferred]]'' is raised for every uploaded file. Also raises [[library_session_filetransferprogress|''Session.FileTransferProgress'']] throughout the transfer. |
| - | The upload aborts on the first error. See example on [[library_example_recursive_download_custom_error_handling|implementing recursive directory tree download with custom error handling]], uploads can be implemented similarly too. See an example of [[library_example_moves_files_keeping_directory_structure|implementing recursive directory tree upload]]. | + | The upload aborts on the first error. See the example on [[library_example_recursive_download_custom_error_handling|implementing recursive directory tree download with custom error handling]]. Uploads can be implemented similarly too, see an example of [[library_example_moves_files_keeping_directory_structure|implementing recursive directory tree upload]]. |
| Contrary to [[library_session_putfiles|''Session.PutFiles'']]: | Contrary to [[library_session_putfiles|''Session.PutFiles'']]: | ||
| * You specify source directory path separately from an optional file mask. | * You specify source directory path separately from an optional file mask. | ||
| - | * You do not specify a target name (or an operation mask) in the destination path (original names are preserved when downloading). | + | * You do not specify a target name (or an operation mask) in the destination path (original names are preserved when uploading). |
| * You do not need to make sure that both directory paths end with (back)slashes. | * You do not need to make sure that both directory paths end with (back)slashes. | ||
| + | |||
| + | ===== [[example]] Examples ===== | ||
| + | |||
| + | ==== Real-Life Examples ==== | ||
| + | |||
| + | * [[extension_synchronize_another_server|*]]; | ||
| + | * [[library_example_winforms_progressbar|*]]. | ||