FTPAttribute (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Identifying the files attributes
Timeout
Internet browser
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 found on 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

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

Syntax

Identifying the attributes of last consulted file Hide the details

<Result> = FTPAttribute()

<Result>: Character string

"ERR" if an error occurred. To find out the error details, use ErrorInfo associated 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 can be accessed in read-only.
H: Hidden file. The file name is grayed 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.
To: "Archive" file. This attribute indicates that the file can be archived. Some programs are using this attribute to find out which files have been saved.
This option is not available.
D: Directory or sub-directory. The file is a directory or a sub-directory.
C: Compressed file (on the NTFS partitions). This file was automatically compressed during its copy on an NTFS partition (Windows NT or 2000).
This option is not available.
This syntax returns the attributes of the last file accessed by one of the following FTP functions: FTPDate, FTPTime, FTPSize, FTPListFile. Unlike the syntax 2, no request is sent to the server. This syntax is recommended.

Identifying the attributes of specified file Hide the details

<Result> = FTPAttribute(<Connection identifier> , <File name>)

<Result>: Character string

"ERR" if an error occurred. To find out the error details, use ErrorInfo associated 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 can be accessed in read-only.
H: Hidden file. The file name is grayed 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.
TO: "Archive" file. This attribute indicates that the file can be archived. Some programs are using this attribute to find out which files have been saved.
This option is not available.
D: Directory or sub-directory. The file is a directory or a sub-directory.
C: Compressed file (on the NTFS partitions). This file was automatically compressed during its copy on an NTFS partition (Windows NT or 2000).
This option is not available.

<Connection identifier>: Integer

Connection identifier, returned by FTPConnect.

<File name>: Character string (with quotes)

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

Remarks

Identifying the files attributes

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

Timeout

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

Internet browser

FTPAttribute requires Internet Explorer version 3 or later.

If a problem occurs, we recommend that you run a test with the browser by directly passing a link such as "ftp://server/...". If a problem occurs with Internet Explorer (with a UNIX server for example), use FTPCommand directly.

Rights of users

Only a user who has read rights on the FTP server can identify the attributes of the files or directories found on an FTP server. In most cases, read rights are granted to the "anonymous" users, giving them the ability to identify the attributes of a file or directory found on an FTP server.

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