fRename (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

External file management functions

WLanguage procedures

fRename

Presentation

Example

Moving the file

Renaming a directory

Renaming an HFSQL data file

Handling errors

Operating mode in Windows Vista (and later)

See also

ChangeSize

FileName

Find

Lock

Read

ReadLine

ReadLineRegularExpression

Seek

Size

Unlock

Write

WriteLine

Constants for external files

DiskFile

Functions for handling directories and external files

Functions for handling directories and external files (prefix syntax)

Handling the external files

Storing files in Android

Summary table: Managing the application directories according to the platform

fAddBuffer

fAddText

fAttribute (Example)

fAttribute

fAttributeReadOnly

fBuildPath

fBuildRelativePath

fCacheDir

fChangeExtension

fChangeSize

fClose (Example)

fClose

fCompare (Example)

fCompare

fCompress (Example)

fCompress

fContentType

fCopyDir (Example)

fCopyDir

fCopyFile (Example)

fCopyFile

fCopyFileWebFolder

fCreate (Example)

fCreate

fCreateLink

fCurrentDir (Example)

fCurrentDir

fCurrentDrive (Example)

fCurrentDrive

fDataDir

fDataDirCommon

fDataDirUser

fDate (Example)

fDate

fDateTime (Example)

fDateTime

fDecrypt (Example)

fDecrypt

fDelete (Example)

fDelete

fDeleteFileWebFolder

fDetectRemovableStorage

fDir (Example)

fDir

fDirAttribute

fDirExist

fDirRename

fDirSize

fDirectoryExist

fDriveInfo (Example)

fDriveInfo

fDriveReady (Example)

fDriveReady

fEncrypt (Example)

fEncrypt

fExeDir

fExtractPath (Example)

fExtractPath

fExtractResource

fFileExist

fFileName

fFind

fGlobalDirCommon

fGlobalDirUser

fGraphicFilter (Example)

fGraphicFilter

fImageSelect (Example)

fImageSelect

fInsertTextAtBeginning

fIsImage

fListDirectory (Example)

fListDirectory

fListDisk

fListFile (Example)

fListFile

fListResource

fLoadBuffer

fLoadResource

fLoadText

fLock (Example)

fLock

fLongName (Example)

fLongName

fLongPath (Example)

fLongPath

fMIMEType

fMakeDir (Example)

fMakeDir

fMerge

fMoveDir (Example)

fMoveDir

fMoveFile

fOpen (Example)

fOpen

fOpenTempFile

fParentDir

fRead (Example)

fRead

fReadLine (Example)

fReadLine

fReadLineRegularExpression

fRemoveDir (Example)

fRemoveDir

fRename (Example)

fRename

fReportsAndQueriesDir

fResourceDir

fSaveBuffer

fSaveText

fSeek (Example)

fSeek

fSelect (Example)

fSelect

fSelectDir (Example)

fSelectDir

fSep

fSeparator

fShortName (Example)

fShortName

fShortPath (Example)

fShortPath

fSize (Example)

fSize

fSizeUncompressed (Example)

fSizeUncompressed

fSplit

fStopCompress (Example)

fStopCompress

fTempDir

fTempFile (Example)

fTempFile

fTempPath (Example)

fTempPath

fTime (Example)

fTime

fTrackDirectory

fTrackFile

fTrackStop

fTrackStopAll

fUncompress (Example)

fUncompress

fUnlock (Example)

fUnlock

fWebDir

fWrite (Example)

fWrite

fWriteLine (Example)

fWriteLine

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

// 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 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.
This parameter is case-sensitive.
Reminder: In Android, 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, as well as to the external memory (SDCard).
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.

<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.
This parameter is case-sensitive.
Reminder: In Android, 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, as well as to the external memory (SDCard).

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.

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.

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

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: To handle and/or modify the files or directories without administrator privileges, you should:

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: 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: wd280std.dll