fRename (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / External file functions

Moving the file
Renaming a directory
Renaming an HFSQL data file
Handling errors
Operating mode in Windows Vista (and later)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

fRename (Function)

In french: fRenomme

Modifies the name of a file.

Example

See additional examples

// Modification du nom d'un fichier
Res = fRename("C:\Répertoire\Fichier.doc", "C:\Répertoire\FichierRenommé.doc")


// Modification du nom du fichier avec déplacement du fichier
Res = fRename("C:\Répertoire\Fichier.doc", "C:\Temp\FichierRenommé.doc")

// Modification du nom du fichier avec déplacement du fichier dans le répertoire en cours
Res = fRename("C:\Répertoire\Fichier.doc", "FichierRenommé.doc")

Syntax

<Result> = fRename(<Path of file to rename> , <New file path>)

<Result>: Boolean

True if the modification was performed,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Path of file to rename>: Character string

Full path of the file to rename (up to 260 characters). A UNC path can be used.
Relative path in relation to the current directory (returned by fCurrentDir). Wildcard characters are not allowed.
This parameter can be in Ansi or Unicode format.

<New file path>: Character string

Full path of the file with the new name (up to 260 characters). A UNC path can be used.
Relative path in relation to the current directory (returned by fCurrentDir).
Wildcard characters are not allowed. The path of the file must exist.
This parameter can be in Ansi or Unicode format.

Remarks

Moving the file

If <Path of file to rename> and <New file path> contain the same file name but different access paths, fRename moves the file.

Renaming a directory

fRename can also be used to rename a directory. To rename a directory, the directory to rename must be different from the current directory of the application.

Renaming an HFSQL data file

To rename an HFSQL data file, use HChangeName.

Handling errors

fRename throws an error in the following cases:

the file to rename does not exist,
the file to rename is locked,
the path of the file to rename is invalid,
<New file path> or <Path of file to rename> is an empty string,
the new file already exists.

Note: This function works on an empty file.

Operating mode in Windows Vista (and later)

If this function does not work 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).

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

Programming tip: If you need to manipulate / modify files or directories, without needing administrator privileges, it is advisable:

avoid writing to the Windows directory or to the "Program Files" directory,
use the system directory of the application (returned by SysDir with the srAppDataCommun constant, for example).

Remark: Under Windows Vista (and higher), the virtualization mechanism makes applications Vista-compatible.. If the file is created in a system directory without having sufficient rights, this file will actually be created in another directory (C:\Users\<LOGIN>AppData\Local\VirtualStore\Windows\). In this case, the file cannot be shared between several applications.

Component: wd300std.dll