fAttributeReadOnly (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

External file management functions

Operating mode in Windows Vista (and later)

See also

Functions for managing external files

fAttributeReadOnly (Function)

In french: fAttributLectureSeule

Specifies whether a text file is read-only and changes the read-only attribute of a file.

Only specifies whether a text file is read-only.

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

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 24 and later

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

New in version 24

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

Example

IF fAttributeReadOnly("C:\temp\Test.doc") = True THEN
Trace("The C:\temp\Test.doc file is read-only")
END

Syntax

Finding out whether a file is read-only Hide the details

<Result> = fAttributeReadOnly(<File name>)

<Result>: Boolean

True if the file is read-only,
False otherwise. The ErrorOccurred variable returns True if an error occurred.

<File name>: Character string (with quotes)

Name and full (or relative) path of file (up to 260 characters). A UNC path can be used.
Versions 15 and later
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
This path must be a full path or a UNC path. It cannot be a relative path.
Versions 17 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
New in version 17
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

Making a file read-only Hide the details

<Result> = fAttributeReadOnly(<File name> , <Change attribute>)

<Result>: Boolean

Previous status of the file:
True if the file was read-only,
False otherwise.
The ErrorOccurred variable returns True if an error occurred.

<File name>: Character string (with quotes)

Name and full (or relative) path of file (up to 260 characters). A UNC path can be used.
Versions 15 and later
This parameter can be in Ansi or Unicode format.
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can be in Ansi or Unicode format.
Name and full path of the file (up to 260 characters).
Versions 17 and later
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
New in version 17
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.
This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories.

<Change attribute>: Boolean

True to make the file read-only,
False otherwise.

Remarks

Notes

This function is faster than fAttribute.

Operating mode in Windows Vista (and later)

If this function does not operate properly in Windows Vista (and later), check whether the file or directory used is not in one of the system directories (Windows directory or "Program Files" directory).

Indeed, in Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have the administrator privileges to handle and/or modify the files or directories in the system directories (Windows directory or "Program Files" directory).

Programming tip: To handle and/or modify the files or directories without administrator privileges, you should:

avoid writing into the Windows directory or into the "Program Files" directory,
use the system directory corresponding to the application (returned by SysDir associated with the srCommonAppData constant).

Component : wd260std.dll