Help / WLanguage / WLanguage functions / Communication / FTP functions
  • Timeout
  • Rights of users
  • Relative and absolute path
  • Required permissions
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
FTPRenameFile (Function)
In french: FTPRenommeFichier
Renames or moves a file (or a directory) found on an FTP server (File Transfer Protocol).
WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget JavaUser code (UMC)Ajax
// The "/Documents/File.txt" file is renamed "/Documents/Draft.txt"
Res = FTPRenameFile(7, "/Documents/File.txt", "/Documents/Draft.txt")
WEBDEV - Server codePHPAjax
// The "/Documents/File.txt" file is renamed "/Documents/Draft.txt"
Res = FTPRenameFile(f, "/Documents/File.txt", "/Documents/Draft.txt")
<Result> = FTPRenameFile(<Connection identifier> , <File/Directory to rename> , <New name of file/directory>)
<Result>: Boolean
  • True if the file was renamed,
  • False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.
<Connection identifier>: Integer
Connection identifier, returned by FTPConnect.
PHP The connection identifier is a variant type.
<File/Directory to rename>: Character string
Name and full (or relative) path of file or directory to rename. The different path sections are separated by "slashes" ("/").
<New name of file/directory>: Character string
Name and full (or relative) path of file or directory. The different path sections are separated by "slashes" ("/"). If the path specified by this parameter differs from the initial path, the file to rename is moved.


By default, all the FTP functions fail if the FTP server does not respond within 20 seconds. This timeout can be modified with FTPConnect when connecting to the FTP server.

Rights of users

Only a user who has write rights on the FTP server can handle the files found on an FTP server. In most cases, no write rights are granted to the "anonymous" users.

Relative and absolute path

The notions of relative path and absolute path are very important in an FTP application.
  • A path starting with a slash is considered as being an absolute path: it is the path in relation to the root of the FTP server (parameter specific to the server).
    ex: /ad/user/JULIA
  • A path not starting with a slash is considered as being a relative path, which means a path given in relation to the current directory. This current directory can be returned or modified by FTPCurrentDir.
When connecting to an FTP site, the initial directory (the "home directory" of the user) is not necessarily found at the root of the FTP server. Therefore, we recommend that you use relative paths.
AndroidAndroid Widget

Required permissions

The call to this function modifies the permissions required by the application.
Required permission : INTERNET
This permission allows the applications to open the network sockets.
Component: wd270com.dll
Minimum version required
  • Version 9
This page is also available for…
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help