fRename (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing external files

Renaming an HFSQL file

Managing errors

Operating mode in Windows Vista (and later)

See also

Constants for the external files

Functions for managing external files

Handling the external files

Storing files in Android

Summary table: Managing the application directories according to the platform

fDetectRemovableStorage

fReadLineRegularExpression

fRemoveDir

fRename

fReportsAndQueriesDir

Moving the file
Renaming a directory
Renaming an HFSQL file
Managing 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

// Modify the name of a file
Res = fRename("C:\Directory\File.doc", "C:\Directory\RenamedFile.doc")

// Modify the name of the file while moving the file
Res = fRename("C:\Directory\File.doc", "C:\Temp\RenamedFile.doc")

// Modify the name of the file while moving the file into the current directory
Res = fRename("C:\Directory\File.doc", "RenamedFile.doc")

Syntax

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

<Result>: Boolean

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

<Path of file to rename>: Character string (with quotes)

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.
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.

<New file path>: Character string (with quotes)

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.
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.

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 file

To rename an HFSQL file, use HChangeName. Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Managing errors

fRename generates 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.

Remark: This function operates on an empty file.

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).

Remark: In Windows Vista (and later), the virtualization mechanism is used to make the applications compatible with Vista. 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 : wd260std.dll