fRename (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for managing external files

Renaming a HFSQL file

Managing errors

Operating mode in Windows Vista (and later)

See also

fRename (Function)

In french: fRenomme

Modifies the name of a file.

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.

This function is now available for Windows Phone applications.

New in version 17

This function is now available for iPhone/iPad applications.

This function is now available for Windows Phone applications.

This function is now available for iPhone/iPad applications.

This function is now available for Windows Phone 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

// 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")

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

Syntax

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

<Result>: Boolean

True if the modification was performed,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Path of the 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).
The wildcard characters are not allowed.
Versions 15 and later
This parameter can be in Ansi or Unicode format.
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 be in Ansi or Unicode format.
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 be in Ansi or Unicode format.
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 path must be a full path or a UNC path. It cannot be a relative path.
Versions 17 and later
This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
Windows Phone: This parameter corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
New in version 17
This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
Windows Phone: This parameter corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
Windows Phone: This parameter corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.

<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).
The 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.
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 be in Ansi or Unicode format.
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 be in Ansi or Unicode format.
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 path must be a full path or a UNC path. It cannot be a relative path.
Versions 17 and later
This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
Windows Phone: This parameter corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
New in version 17
This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
Windows Phone: This parameter corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
Windows Phone: This parameter corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.

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 a HFSQL file

To rename a HFSQL file, use HChangeName.

Note: 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 : wd240std.dll