FTPAttribute (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / FTP functions

Identifying the file attributes
Timeout
Rights of users
Relative and absolute path
Required permissions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FTPAttribute (Function)

In french: FTPAttribut

Identifies the attributes of a file located on an FTP server (File Transfer Protocol).

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

// Find out the attributes of
// "/Documents/File.doc" found on the FTP server
ResAttributes = FTPAttribute(ConnectionNum, "/Documents/File.doc")

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)

// Find out the attributes of
// "/Documents/File.doc" found on the FTP server
ResAttributes = FTPAttribute(MyFTPConnection, "/Documents/File.doc")

Syntax

New in SaaS

Syntax not available in PHP

Identifying the attributes of a file (connection established via an ftpConnection variable) Hide the details

<Result> = FTPAttribute(<FTP connection> [, <File name>])

<Result>: Character string

"ERR" if an error occurred. To get more details on the error, use ErrorInfo with the errMessage constant.
One or more letters corresponding to the file attributes ("AH" for example). The following letters are used:
R: Read-only file. The file is read-only.
H: Hidden file. The file name is grayed out or invisible in the explorer.
This option is not available.
S: System file. The file is a Windows system file.
This option is not available.
A: "Archive" file. This attribute indicates that the file can be archived. Some programs use this attribute to determine which files have been saved.
This option is not available.
D: Directory or subdirectory. The file is a directory or a subdirectory.
C: Compressed file (on the NTFS partitions). The file was automatically compressed when copied to an NTFS partition (Windows NT or 2000).
This option is not available.

<FTP connection>: ftpConnection variable

Name of the ftpConnection variable that describes the characteristics of the connection to the FTP server.
Note: This variable type is only available from WINDEV Suite SaaS 2025 - Update 2.
For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.

<File name>: Optional character string

Name and full (or relative) path of the file be accessed. The different path sections are separated by "slashes" ("/").
If this parameter is not specified, the attributes returned will be those of the last file accessed using one of the following FTP functions: FTPDate, FTPTime, FTPSize, FTPListFile. In this case, no request is sent to the server. This syntax is recommended.

Identifying the attributes of a file (connection established via the FTP server connection ID) Hide the details

<Result> = FTPAttribute([<Connection ID> , <File name>]])

<Result>: Character string

"ERR" if an error occurred. To get more details on the error, use ErrorInfo with the errMessage constant.
One or more letters corresponding to the file attributes ("AH" for example). The following letters are used:
R: Read-only file. The file is read-only.
H: Hidden file. The file name is grayed out or invisible in the explorer.
This option is not available.
S: System file. The file is a Windows system file.
This option is not available.
A: "Archive" file. This attribute indicates that the file can be archived. Some programs use this attribute to determine which files have been saved.
This option is not available.
D: Directory or subdirectory. The file is a directory or a subdirectory.
C: Compressed file (on the NTFS partitions). The file was automatically compressed when copied to an NTFS partition (Windows NT or 2000).
This option is not available.

<Connection ID>: Integer

Connection identifier, returned by FTPConnect.
The connection identifier is a variant type.

<File name>: Character string

Name and full (or relative) path of the file be accessed. The different path sections are separated by "slashes" ("/").

Note: If the <Connection ID> and <File name> parameters are not specified, the attributes returned will be those of the last file accessed using one of the following FTP functions: FTPDate, FTPTime, FTPSize, FTPListFile. In this case, no request is sent to the server. This syntax is recommended.

Remarks

Identifying the file attributes

To get the different file attributes, check whether one of the letters identifying an attribute is in <Result>. This search can be performed using Position, for example.

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