FTPRemoveDir (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Timeout
Rights of users
Relative and absolute path
Required permissions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FTPRemoveDir (Function)

In french: FTPRepSupprime

Deletes a directory and its content (files and sub-directories) from an FTP server (File Transfer Protocol).

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 18 and later

This function is now available in Android widget mode.

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available in Android widget mode.

This function is now available for iPhone/iPad applications.

This function is now available in Android widget mode.

This function is now available for iPhone/iPad applications.

Example

See additional examples

// Delete the "/Documents/File.DOC" file from the FTP server
RemoveDirResult = FTPRemoveDir(7, "/Documents/File")

Syntax

<Result> = FTPRemoveDir(<Connection identifier> , <Directory to delete>)

<Result>: Boolean

True if the directory was deleted,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Connection identifier>: Integer

Connection identifier, returned by FTPConnect.

<Directory to delete>: Character string

Name and full (or relative) path of directory to delete. The different path sections are separated by "slashes" ("/").

Remarks

Timeout

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 or the directories 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.

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