DirectoryOperations

This function supports copying, moving, creating, and deleting directories (folders), as well as determining if a directory exists.

Properties

  • Action

    The action to perform on the source directory. The available actions are Copy, Move, Create, Delete, and Directory exists.

  • Source directory

    Visible when Action is either Copy or Move. Indicates the full path of the directory on which to perform the action.

  • Target directory

    Visible when Action is either Copy or Move. Indicates the full path to the destination directory.

  • Directory

    Visible when Action is Create, Delete, or Directory exists. Indicates the full path of the directory on which to perform the action.

  • Directory exists

    What to do when the Target directory already exists.

    When the selected Action is Create or Delete, the following options are available:

    • Overwrite directory replaces the entire contents of the target directory with the contents of the source directory.

    • Merge directory retains all existing sub-directories and files in the target directory. Files that also exist in the source directory will replace those in the target directory based on the Replace existing files property.

    • Do nothing keeps the target directory unchanged.

    When the selected Action is Create, the following options are available in case the directory already exists:

    • Do nothing performs no action.

    • Increment folder name will add a number to the end of the folder name to make the name unique. This is a sequential number starting with 1.

    • Clear will delete the entire contents of the directory.

    • Throw exception will stop the process and return an error.
  • Replace existing files

    Visible when the Action is Copy or Move, and the Directory exists option selected is Merge directory. Selects if any file already in the destination directory that is also in the source directory should be replaced by the file in the source directory. If this option is unchecked, all existing files in the target directory will be kept unchanged.

Output

If Action is Create, the function returns the name of the folder that was created.

If Action is Directory exists, the return value is a boolean value indicating if the directory exists.