FileCopyDir()

Mfunc.FileCopyDir(Source, Dest [, Flag])

Mfunc.FileCopyDir(Source, Dest [, Flag])

Copies a folder along with all its sub-folders and files (similar to xcopy).

Parameters

Source

Name of the source directory (with no trailing backslash), which is assumed to be in %A_WorkingDir% if an absolute path isn't specified. For example: C:\My Folder

Dest

Name of the destination directory (with no trailing baskslash), which is assumed to be in %A_WorkingDir%if an absolute path isn't specified. For example: C:\Copy of My Folder

Flag

(optional) this flag determines whether to overwrite files if they already exist:
0 = (default): Do not overwrite existing files. The operation will fail and have no effect if Dest already exists as a file or directory.
1 = Overwrite existing files. However, any files or subfolders inside Dest that do not have a counterpart in Source will not be deleted.
This parameter can be an expression, even one that evalutes to true or false (since true and false are stored internally as 1 and 0).

Throws

Throws MfException throw any errors with InnerException set to the Autohotkey - FileCopyDir error message.
Throws MfException any other general error occurs.

Remarks

Wrapper for AutoHotkey Docs - FileCopyDir.
Static method.

If the destination directory structure doesn't exist it will be created if possible.

ErrorLevel is set to 1 if there was a problem or 0 otherwise. However, if the source directory contains any saved webpages consisting of a PageName.htm file and a corresponding directory named PageName_files, an error may be indicated even when the copy is successful.

Mfunc.FileCopyDir copies a single folder. To instead copy the contents of a folder (all its files and subfolders), see the examples section of Mfunc.FileCopy.

If the source directory contains any saved webpages consisting of a PageName.htm file and a corresponding directory named PageName_files, an error may be thrown even when the copy is successful.

Any and/or all parameter for this function can be instance of MfString or var containing string.

See Also:AutoHotkey Docs - FileCopyDir.

Example

Mfunc.FileCopyDir("C:\My Folder", "C:\Copy of My Folder")

; Example #2: A working script that prompts you to copy a folder.
SourceFolder := Mfunc.FileSelectFolder( , 3, "Select the folder to copy")
if SourceFolder =
    return
; Otherwise, continue.
TargetFolder := Mfunc.FileSelectFolder( , 3, "Select the folder IN WHICH to create the duplicate folder.")
if TargetFolder =
    return
; Otherwise, continue.
MsgBox, 4, , A copy of the folder "%SourceFolder%" will be put into "%TargetFolder%".  Continue?
IfMsgBox, No
    return
Mfunc.SplitPath(SourceFolder, SourceFolderName)  ; Extract only the folder name from its full path.
Mfunc.FileCopyDir(SourceFolder, TargetFolder . "\" . SourceFolderName)
if ErrorLevel
    MsgBox The folder could not be copied, perhaps because a folder of that name already exists in "%TargetFolder%".
return