# CopyFiles Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Unknown Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SourcePath : `PathString` |

Source path relative to the share where files will be copied from.

Can be a directory path or a specific file path.

Empty means root directory.


Default: -
Example: documents/reports

| | TargetPath : `PathString` |

Target path relative to the share where files will be copied to.

Must be a directory path.

Empty means root directory.


Default: -
Example: backup/reports

| | {% endtab %} | | {% tab title="Parameter: Connection" %} | Name | Description | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Server : `String` |

SMB server address or hostname.


Default: -
Example: 127.0.0.1

| | Share : `String` |

SMB share name to connect to.


Default: -
Example: testShare

| | Username : `String` |

Username for SMB authentication.

This needs to be of format domain\username


Default: -
Example: WORKGROUP\Administrator

| | 🗝Password : `String` |

Password for the SMB credentials.


Default: -
Example: Password123

| | OperatingSystem : `Os` |

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Possible values:

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.


Default: 2
Example: Linux

| | {% endtab %} | | {% tab title="Parameter: Options" %} | Name | Description | | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | CreateTargetDirectories : `Boolean` |

If true, creates the target directory and any necessary parent directories if they don't exist.


Default: True
Example: true

| | IfTargetFileExists : `FileExistsAction` |

Specifies the action to take when a file with the same name already exists in the target location.

Possible values:

Specifies the action to take when a file with the same name already exists in the target location.

Specifies the action to take when a file with the same name already exists in the target location.

Specifies the action to take when a file with the same name already exists in the target location.


Default: 1
Example: Throw

| | PreserveDirectoryStructure : `Boolean` |

If true, recreates the source directory structure in the target location.

If false, all files are moved directly to the target directory without preserving subdirectories.


Default: True
Example: true

| | Recursive : `Boolean` |

Search for files recursively in subdirectories. Default is true.


Default: True
Example: true

| | PatternMatchingMode : `PatternMatchingMode` |

Define how pattern matching will work.

Possible values:

Define how pattern matching will work.

Define how pattern matching will work.


Default: 2
Example: Regex

| | Pattern : `String` |

Define how pattern matching will work.


Default: -
Example: Regex

| | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure.


Default: True
Example: false

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.


Default: -
Example: Custom error message

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates if the task completed successfully.
Example: true

| | Files : `List` |

List of files that were successfully copied, including their source and target paths.
Example: \[{SourcePath: "documents\report.txt", TargetPath: "archive\report.txt"}]

| | Error : `Error` |

Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.0.0] - 2026-04-08 #### Added * New connection parameters that defined what servers Operating System. * \[Breaking Change] Introduce PathString type that will represent paths with OS specific separators. ### \[1.0.0] - 2025-11-20 #### Added * Initial implementation {% endtab %} {% endtabs %}