Transfer Files
- 14 May 2021
- 1 Minute to read
-
Print
-
DarkLight
-
PDF
Transfer Files
- Updated on 14 May 2021
- 1 Minute to read
-
Print
-
DarkLight
-
PDF
This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.
Transfer Files
Copies files from a directory on a source server to a directory on a target server.
Script usage:
Transfer-Files( [Include: <@(text)>], [Exclude: <@(text)>], [FromDirectory: <text>], [FromServer: <text>], ToDirectory: <text>, [ToServer: <text>], [DeleteTarget: <true/false>], [SetLastModifiedDate: <true/false>], [BatchSize: <integer>], [Verbose: <true/false>] );
This operation may be prefixed with Files::, although this is a built-in namespace and isn't really necessary.
Arguments:
| Name | Format | Script Usage | Usage Notes |
|---|---|---|---|
| Include | @(text) | Include | See KB#1119 to learn more about masking syntax. |
| Exclude | @(text) | Exclude | See KB#1119 to learn more about masking syntax. |
| Source directory | text | FromDirectory | |
| Source server | text | FromServer | |
| ☆ Target directory | text | ToDirectory | This argument is required. |
| Target server | text | ToServer | |
| Delete target | true/false | DeleteTarget | When set to true, files in the target directory will be deleted if they are not present in the source directory. If false, files present in the target directory that are not present in the source directory are unmodified. |
| Set last modified | true/false | SetLastModifiedDate | When true, the modified date on any transferred files will be set to match their source files. |
| Batch size | integer | BatchSize | The number of files to transfer in each batch. |
| Verbose | true/false | Verbose |
Was this article helpful?
