FTPRenameFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / FTP functions

Timeout
Rights of users
Relative and absolute path
Required permissions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FTPRenameFile (Function)

In french: FTPRenommeFichier

Renames or moves a file or a directory located on an FTP server.

New in SaaS
A new syntax for manipulating variables of type ftpConnection is available from WINDEV Suite SaaS 2025 - Update 2.

For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.

Example

See additional examples

// Connect the current computer to the FTP server
ConnectionNumber = FTPConnect("192.54.12.8")
// The "/Documents/File.txt" file is renamed "/Documents/Draft.txt"
Res = FTPRenameFile(ConnectionNumber, "/Documents/File.txt", "/Documents/Draft.txt")

// The "/Documents/File.txt" file is renamed "/Documents/Draft.txt"
Res = FTPRenameFile(f, "/Documents/File.txt", "/Documents/Draft.txt")

New in SaaS

// Syntax not available in PHP
// Connect the current computer to the FTP server
MyFTPConnection is ftpConnection
MyFTPConnection.Server = "192.54.12.8"
FTPConnect(MyFTPConnection)

// The "/Documents/File.txt" file is renamed "/Documents/Draft.txt"
Res = FTPRenameFile(MyFTPConnection, "/Documents/File.txt", "/Documents/Draft.txt")

Syntax

<Result> = FTPRenameFile(<FTP connection> , <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.

<FTP connection>: Integer or ftpConnection variable

Connection identifier, returned by FTPConnect.
This parameter is a Variant parameter.
New in SaaS
Name of the ftpConnection variable that corresponds to the FTP connection used.
Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 2.
For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.
Not available.

<File/Directory to rename>: Character string

Name and full or relative path of the file or directory to rename. The different parts of the path are separated by "slashes" ("/").

<New name of file/directory>: Character string

Name and full or relative path of the file or directory. The different parts of the path are separated by "slashes" ("/"). If the path specified by this parameter is different from the initial path, the file to be renamed is moved.

Remarks

Timeout

By default, all the FTP functions fail if the FTP server does not respond within 20 seconds. This time can be modified:

when connecting to the FTP server with FTPConnect (<Timeout> parameter).
New in SaaS
when defining the parameters of the ftpConnection variable (Timeout property).
Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 2.
For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.

Rights of users

Only a user who has read rights on the FTP server can get information about the files or the directories located on an FTP server. In most cases, the read 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 beginning with a slash is considered an absolute path. This path is relative to the root of the FTP server (server-specific parameter).
ex: /pub/user/JULIA
If the path does not begin with a slash, it is considered a relative path, i.e. the path relative to the current directory. This current directory can be obtained or changed using FTPCurrentDir.

When connecting to an FTP site, the initial directory (the "base directory" of the user) is not necessarily found at the root of the FTP server. Therefore, we recommend that you use relative paths.

Required permissions

This function changes the permissions required by the application.
Required permission: INTERNET
This permission allows the applications to open the network sockets.

Business / UI classification: Business Logic

Component: wd300com.dll