\(\renewcommand\AA{\unicode{x212B}}\)
DownloadRemoteFile dialog.
Table of Contents
Warning
DownloadRemoteFile is deprecated and has no replacement.
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| ComputeResource | Input | string | Mandatory | The name of the remote computer holding the file |
| TransactionID | Input | string | Mandatory | The ID of the transaction that owns the file |
| RemoteFileName | Input | string | Mandatory | The name of the file on the remote machine. (Filename only; no path) |
| LocalFileName | Input | string | Mandatory | The full pathname on the local machine where the downloaded file should be saved. |
Download a file from a remote compute resource. Files are available for transactions, and you can retrieve the list of available files with QueryRemoteFile v2. See StartRemoteTransaction v2 for how to start (create) a newtransaction.
For specific details on remote algorithms when using the Mantid web service remote job submission API, see the remote job submission API docs.
Version 1 downloads files using the Mantid remote job submission API. This is still supported as one of the variants of Versions 2 and above, when the compute resource uses the Mantid remote job submission API as job manager (underlying remote job scheduling mechanism).
Categories: AlgorithmIndex | Remote | Deprecated
C++ header: DownloadRemoteFile2.h (last modified: 2021-06-03)
C++ source: DownloadRemoteFile2.cpp (last modified: 2021-03-31)