diff --git a/docs/xml/lcl/fileutil.xml b/docs/xml/lcl/fileutil.xml
index 4d0c415d33..c751f20d0f 100644
--- a/docs/xml/lcl/fileutil.xml
+++ b/docs/xml/lcl/fileutil.xml
@@ -196,12 +196,13 @@
- FileIsText - checks whether the supplied file name refers to a readale text file
+ FileIsText - checks whether the supplied file name refers to a readable text file
- FileIsText - checks whether the supplied file name refers to a readale text file
- Searches the opening section of the file for non-text characters such as ASCII 0 to 31 (except CR and LF, the new line characters)
+ FileIsText - checks whether the supplied file name refers to a readable text file
+ Searches the opening section of the file (first 1024 characters) for non-text characters such as ASCII 0 to 31 (except CR and LF, the new line characters)
+ If there is a file reading error, an Exception is raised and FileReadable returns False
@@ -213,16 +214,18 @@
- Returns false if non-text characters are detected
+ Returns false if a file reading Exception is encountered
FileIsExecutable - checks if
+
AFileName refers to an executable file
FileIsExecutable - checks if
+
AFileName refers to an executable file
On Windows systems, if the file exists it is regarded as executable.
On other systems (eg Unix etc), looks at file permissions to see whether execute flag is set
@@ -287,22 +290,32 @@
-
-
-
-
+
+ ReadAllLinks - tries to find the file that is referred to by the symbolic link in
+ FileName
+
+
+
+ ReadAllLinks - tries to find the file that is referred to by the symbolic link in
+
+ FileName
+
+ No function in Windows systems
+ On Unix-like systems, finds the linked file and returns its full path and filename, or (if ExceptionOnError has been set True) an Exception is raised with appropriate error message
+
+ If an error is encountered on trying to read the link, provided ExceptionOnError has been set True an Exception is raised with appropriate error message. Otherwise an error results in the return of an empty string.
-
+ Returns the full path and filename of the target file; empty if the file is not found, or the original FileName on Windows systems
-
+ The string containing the symbolic link
-
+ If True, an Exception is raised on encountering a file error
@@ -333,6 +346,7 @@
DeleteDirectory - Delete the named directory (or only its contents if
+
OnlyChilds is True)
If there was an error, such as trying to removing . or .., or there were insufficient permissions, or the file did not exist, False is returned
@@ -350,14 +364,12 @@
-
-
-
-
+
+ ProgramDirectory - returns the directory in which the currently running program resides
-
+ Returns the name of the directory in which the current program is found
@@ -435,10 +447,12 @@
+
Ext must match case in
+
FileName
@@ -521,6 +535,7 @@
CleanAndExpandDirectory - trims and cleans
+
FileName and appends a directory delimiter to it
@@ -537,9 +552,11 @@
CreateAbsoluteSearchPath - concatenates
+
BaseDirectory and
+
SearchPath to form an absolute path to search for files
@@ -547,10 +564,12 @@
+
BaseDirectory and
+
SearchPath to form an absolute path to search for files
Adds appropriate path delimiters to the BaseDirectory string, then adds the search path, checking that each directory in the path is in fact an absolutely specified directory, then returns the fully formed absolute search path.
@@ -581,12 +600,14 @@
CreateRelativePath - given an absolute path and a
+
BaseDirectory, create a search path relative to the current directory
CreateRelativePath - given an absolute path and a
+
BaseDirectory, create a search path relative to the current directory
The returned string includes the correct number of dots and double dots to signify relativity to the current directory (eg ../../or ..\..\ etc)
@@ -610,7 +631,9 @@
FileIsInPath - checks that
+
FileName refers to a file that exists within the given
+
Path
@@ -631,13 +654,17 @@
FileIsInDirectory - checks whether a file with
+
FileName exists within the given
+
Directory
FileIsInDirectory - checks whether a file with
+
FileName exists within the given
+
Directory
@@ -788,6 +815,7 @@
FindDiskFileCaseInsensitive - searches for the given
+
FileName in a case insensitive manner
@@ -1045,18 +1073,24 @@
-
-
-
-
+
+ ReadFileToString - returns a string with the contents of the named file
+
+
+
+
+ Opens the file and reads its contents into a Stream, then reads the stream to construct the
+ Result string
+
+ If there is an error in reading the file, an exception is raised and an empty string is returned
-
+ The contents of the file as a string, or an empty string if there is an error or the file is empty
-
+ The name of the file for processing