fAttributeReadOnly (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / External file management functions

Notes
Operating mode in Windows Vista (and later)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

fAttributeReadOnly (Function)

In french: fAttributLectureSeule

Gets and sets the read-only attribute of a file.

Only indicates if a file is read-only

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. If an error occurs, the ErrorOccurred variable returns True.

<File name>: Character string

Name and full (or relative) path of file (up to 260 characters). A UNC path can be used.
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 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.
If an error occurs, the ErrorOccurred variable returns True.

<File name>: Character string

Name and full (or relative) path of file (up to 260 characters). A UNC path can be used.
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: 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).

In Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have administrator privileges to handle and/or modify the files or directories in 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 to the Windows directory or to the "Program Files" directory,
use the system directory of the application (returned by SysDir with the srAppDataCommun constant, for example).

Component: wd280std.dll