fCopyFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing external files

Operating mode in Windows Vista (and later)

Creating directories during the copy

Equivalence

Related examples

See also

fCopyFile (Function)

In french: fCopieFichier

Copies one or more files (regardless of their attributes).

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

// Copy "File.doc" to "FileCopy.doc"
Res = fCopyFile("C:\Directories\File.doc", "D:\Documents\FileCopy.doc")

// Copy a file
Res = fCopyFile("\Directories\File.psw", "\Documents\FileCopy.psw")

// Copy the files found in the "C:\MyImages" directory
// The subdirectories and their files are taken into account (frRecursive constant)
ResCopy = fCopyFile("C:\MyImages\*.*", "D:\MyFiles\", frRecursive)

Syntax

Copying a a file or a directory Hide the details

<Result> = fCopyFile(<Source file> , <Destination file or directory> [, <Copy indicator>])

<Result>: Boolean

True if the files have been copied,
False otherwise. To get the details of the error, use ErrorInfo with the errMessage constant.

<Source file>: Character string (with quotes)

File to copy (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically sought in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
Special cases according to the platforms:
Versions 15 and later
This parameter can be in Ansi or Unicode format.
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can be in Ansi or Unicode format.
Versions 15 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
New in version 15
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
Versions 17 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
New in version 17
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
Management of wildcard characters (*,?): By default, the wildcard characters are allowed in the name of the file.
Special case according to the platform:
Versions 18 and later
Wildcard characters (*,?) are not allowed in the file name.
New in version 18
Wildcard characters (*,?) are not allowed in the file name.
Wildcard characters (*,?) are not allowed in the file name.
If the "*.*" expression is used, only the files that have an extension will be copied.
Wildcard characters (*,?) are allowed in the file path and in the file name.
Wildcard characters (*,?) are not allowed.

<Destination file or directory>: Character string (with quotes)

Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically created in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
a full or relative path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
Special cases according to the platforms:
Versions 15 and later
This parameter can be in Ansi or Unicode format.
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can be in Ansi or Unicode format.
Versions 15 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
New in version 15
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
This parameter can correspond to:
a file name with its path.
a path, only for a copy with wildcard characters. If this parameter corresponds to a directory name, this name may (or may not) end with "\".

Versions 17 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
New in version 17
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<Copy indicator>: Optional constant

Type of copy to perform:
frConfirm Copy a file and ask for confirmation before overwriting a file with the same name.
This constant is not available.
frProgress A progress window is displayed. If the file is small (a few bytes), the progress bar is not displayed.
This constant is not available.
frRecursive Recursive copy of the files. The subdirectories and their files are taken into account.

<Copy indicator> is empty by default. None of these options is selected.
This parameter is not available.

Versions 19 and later

Copying one or more files by handling each copied file Hide the details

<Result> = fCopyFile(<Source file> , <Destination file or directory> , <WLanguage procedure> [, <Pointer> [, <Copy indicator>]])

<Result>: Boolean

True if the files have been copied,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Source file>: Character string (with quotes)

File to copy (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically sought in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
Wildcard characters (*,?) are allowed in the file name.
Wildcard characters (*,?) are not allowed in the file name.
This parameter can be in Ansi or Unicode format.
Name and full path of the file to copy (up to 260 characters). Wildcard characters (*,?) are not allowed.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<Destination file or directory>: Character string (with quotes)

Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically created in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
a full or relative path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
This parameter can be in Ansi or Unicode format.
Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name with its path.
a path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure ("callback" procedure) that will be called for each copied file. This procedure is used to handle the current file.
For more details on this procedure, see Parameters of the procedure used by fCopyFile.

<Pointer>: Optional integer

Pointer passed to <Procedure name>.

<Copy indicator>: Optional constant

Type of copy to perform:
frRecursive Recursive copy of the files. The subdirectories and their files are taken into account.

<Copy indicator> is empty by default: the process is not recursive.
This parameter is not available.

New in version 19

Copying one or more files by handling each copied file Hide the details

<Result> = fCopyFile(<Source file> , <Destination file or directory> , <WLanguage procedure> [, <Pointer> [, <Copy indicator>]])

<Result>: Boolean

True if the files have been copied,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Source file>: Character string (with quotes)

File to copy (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically sought in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
Wildcard characters (*,?) are allowed in the file name.
Wildcard characters (*,?) are not allowed in the file name.
This parameter can be in Ansi or Unicode format.
Name and full path of the file to copy (up to 260 characters). Wildcard characters (*,?) are not allowed.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<Destination file or directory>: Character string (with quotes)

Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically created in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
a full or relative path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
This parameter can be in Ansi or Unicode format.
Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name with its path.
a path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure ("callback" procedure) that will be called for each copied file. This procedure is used to handle the current file.
For more details on this procedure, see Parameters of the procedure used by fCopyFile.

<Pointer>: Optional integer

Pointer passed to <Procedure name>.

<Copy indicator>: Optional constant

Type of copy to perform:
frRecursive Recursive copy of the files. The subdirectories and their files are taken into account.

<Copy indicator> is empty by default: the process is not recursive.
This parameter is not available.

Copying one or more files by handling each copied file Hide the details

<Result> = fCopyFile(<Source file> , <Destination file or directory> , <WLanguage procedure> [, <Pointer> [, <Copy indicator>]])

<Result>: Boolean

True if the files have been copied,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Source file>: Character string (with quotes)

File to copy (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically sought in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
Wildcard characters (*,?) are allowed in the file name.
Wildcard characters (*,?) are not allowed in the file name.
This parameter can be in Ansi or Unicode format.
Name and full path of the file to copy (up to 260 characters). Wildcard characters (*,?) are not allowed.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<Destination file or directory>: Character string (with quotes)

Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name. This file will be automatically created in the current directory (returned by fCurrentDir).
a file name with its full or relative path. A UNC path can be used.
a full or relative path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
This parameter can be in Ansi or Unicode format.
Destination file and/or directory (up to 260 characters). This parameter can correspond to:
a file name with its path.
a path, only for a copy with wildcard characters.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure ("callback" procedure) that will be called for each copied file. This procedure is used to handle the current file.
For more details on this procedure, see Parameters of the procedure used by fCopyFile.

<Pointer>: Optional integer

Pointer passed to <Procedure name>.

<Copy indicator>: Optional constant

Type of copy to perform:
frRecursive Recursive copy of the files. The subdirectories and their files are taken into account.

<Copy indicator> is empty by default: the process is not recursive.
This parameter is not available.

Remarks

Managing errors

fCopyFile generates an error in the following cases:

the file to copy does not exist,
the file to copy is locked,
is invalid,
<Path of copied file> is an empty string,
<Path of file to copy> and <Path of copied file> are identical.

Operating mode in Windows Vista (and later)

If this function does not operate properly in Windows Vista (and later), check whether the file or directory used is not in one of the system directories (Windows directory or "Program Files" directory).

Indeed, in Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have the administrator privileges to handle and/or modify the files or directories in the system directories (Windows directory or "Program Files" directory).

Programming tip: To handle and/or modify the files or directories without administrator privileges, you should:

avoid writing into the Windows directory or into the "Program Files" directory,
use the system directory corresponding to the application (returned by SysDir associated with the srCommonAppData constant).

Creating directories during the copy

If one of the directories of the destination path does not exist, it is automatically created.
If the source file corresponds to all the files found in a directory (for example, C:\Temp\*.*), the frRecursive constant must be used to create the subdirectories in the destination (and to copy their content).

Remark: To copy directories, you also have the ability to use fCopyDir.

Equivalence

The operating mode of fCopyFile is equivalent to the operating mode of ceCopyFile.

The only difference is:

fCopyFile handles the files found on the Pocket PC from a WINDEV Mobile application.
ceCopyFile handles the files found on the Pocket PC from a WINDEV application.

Related Examples:

Unit examples (WINDEV): Handling text files

[ + ] Handling "text" files with WINDEV:
- Create a text file
- Write into a text file
- Read in a text file

Unit examples (WEBDEV): Handling text files

[ + ] This example explains how to handle "non HFSQL" files with WEBDEV and it allows you to:
- Create a text file
- Write into a text file
- Read in a text file

Unit examples (WINDEV Mobile): Handling text files

[ + ] Handling external "text" files:
- Create a text file
- Write into a text file
- Read in a text file

Component : wd260std.dll