paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-15 18:19:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - more methods defined in FileUtil.xml

Browse Source 
git-svn-id: trunk@15273 -
This commit is contained in:
kirkpatc 2008-05-29 07:55:13 +00:00
parent abd20effbe
commit 90fb54104d
1 changed files with 98 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

171
docs/xml/lcl/fileutil.xml
View File

@ -71,48 +71,58 @@
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FilenameIsAbsolute"> <element name="FilenameIsAbsolute">
<short/> <short>Checks whether an absolute file name is given in <var>TheFileName</var>
<descr/> </short>
<errors/> <descr>
<seealso/> <p>Checks whether an absolute file name is given in <var>TheFileName</var>
</p>
<p>Makes use of <var>FilenameIsWinAbsolute</var> on Windows systems, otherwise uses <var>FilenameIsUnixAbsolute</var>
</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FilenameIsAbsolute.Result"> <element name="FilenameIsAbsolute.Result">
<short/> <short>Returns True if an absolute filename has been supplied</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FilenameIsAbsolute.TheFilename"> <element name="FilenameIsAbsolute.TheFilename">
<short/> <short>The name of the file to be checked</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FilenameIsWinAbsolute"> <element name="FilenameIsWinAbsolute">
<short/> <short>
<descr/> <var>FilenameIsWinAbsolute</var> - checks that the supplied name is an absolute file name for the Windows system</short>
<errors/> <descr>
<seealso/> <p>
<var>FilenameIsWinAbsolute</var> - checks that the supplied name is an absolute file name for the Windows system</p>
<p>Looks, for instance, for Drive Letters and colon at the beginning of the string</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FilenameIsWinAbsolute.Result"> <element name="FilenameIsWinAbsolute.Result">
<short/> <short>Returns True if this is a true absolite Windows filename</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FilenameIsWinAbsolute.TheFilename"> <element name="FilenameIsWinAbsolute.TheFilename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FilenameIsUnixAbsolute"> <element name="FilenameIsUnixAbsolute">
<short/> <short>
<descr/> <var>FilenameIsUnixAbsolute</var> - checks that the supplied name is an absolute filename in Unix systems</short>
<errors/> <descr>
<seealso/> <p>
<var>FilenameIsUnixAbsolute</var> - checks that the supplied name is an absolute filename in Unix systems</p>
<p>Checks that the name is non-empty and starts with a slash</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FilenameIsUnixAbsolute.Result"> <element name="FilenameIsUnixAbsolute.Result">
<short/> <short>Returns True if the supplied name is a correct Absolute file name for a Unix system</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FilenameIsUnixAbsolute.TheFilename"> <element name="FilenameIsUnixAbsolute.TheFilename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- procedure Visibility: default --> <!-- procedure Visibility: default -->
<element name="CheckIfFileIsExecutable"> <element name="CheckIfFileIsExecutable">
@ -148,52 +158,62 @@
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FileIsReadable"> <element name="FileIsReadable">
<short/> <short>
<descr/> <var>FileIsReadable</var> - checks whether supplied file name refers to a readable file</short>
<errors/> <descr>
<seealso/> <p>
<var>FileIsReadable</var> - checks whether supplied file name refers to a readable file</p>
<p>Always true on Windows systems.</p>
<p>On Unix systems, checks permissions of file</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FileIsReadable.Result"> <element name="FileIsReadable.Result">
<short/> <short>Always true in Windows; in Unix systems, returns true if read permission exists for the file</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FileIsReadable.AFilename"> <element name="FileIsReadable.AFilename">
<short/> <short>Name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FileIsWritable"> <element name="FileIsWritable">
<short/> <short>
<descr/> <var>FileIsWritable</var> - checks if the supplied file name refers to a file that is writable</short>
<errors/> <descr>
<seealso/> <p>
<var>FileIsWritable</var> - checks if the supplied file name refers to a file that is writable</p>
<p>Checks file permissions in both Unix and Windows systems</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FileIsWritable.Result"> <element name="FileIsWritable.Result">
<short/> <short>Returns True if Write permission exists</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FileIsWritable.AFilename"> <element name="FileIsWritable.AFilename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FileIsText"> <element name="FileIsText">
<short/> <short>
<descr/> <var>FileIsText</var> - checks whether the supplied file name refers to a readale text file</short>
<errors/> <descr>
<seealso/> <p>
<var>FileIsText</var> - checks whether the supplied file name refers to a readale text file</p>
<p>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)</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FileIsText.Result"> <element name="FileIsText.Result">
<short/> <short>Returns True if the file is a text file</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FileIsText.AFilename"> <element name="FileIsText.AFilename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FileIsText.FileReadable"> <element name="FileIsText.FileReadable">
<short/> <short>Returns false if non-text characters are detected</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FileIsExecutable"> <element name="FileIsExecutable">
@ -212,33 +232,34 @@
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FileIsSymlink"> <element name="FileIsSymlink">
<short/> <short>
<descr/> <var>FileIsSymLink</var> - check if file name is a symbolic link</short>
<errors/> <descr>
<seealso/> <p>
<var>FileIsSymLink</var> - check if file name is a symbolic link</p>
<p>On Windows systems, always returns false. On others, returns true if it is a symbolic link</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FileIsSymlink.Result"> <element name="FileIsSymlink.Result">
<short/> <short>Returns True if file name is a symbolic link (always false in Windows systems)</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FileIsSymlink.AFilename"> <element name="FileIsSymlink.AFilename">
<short/> <short>Name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FileSize"> <element name="FileSize">
<short/> <short>
<descr/> <var>FileSize</var> - finds the size of the named file</short>
<errors/>
<seealso/>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FileSize.Result"> <element name="FileSize.Result">
<short/> <short>Returns the size of the file, or -1 if not there</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FileSize.Filename"> <element name="FileSize.Filename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="GetFileDescription"> <element name="GetFileDescription">
@ -276,18 +297,15 @@
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="DirPathExists"> <element name="DirPathExists">
<short/> <short>Checks if the given directory path exists</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="DirPathExists.Result"> <element name="DirPathExists.Result">
<short/> <short>Returns True if the given directory path exists</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="DirPathExists.FileName"> <element name="DirPathExists.FileName">
<short/> <short>Name of the directory path to be checked</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="ForceDirectory"> <element name="ForceDirectory">
@ -372,18 +390,16 @@
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="ExtractFileNameWithoutExt"> <element name="ExtractFileNameWithoutExt">
<short/> <short>
<descr/> <var>ExtractFileNameWithoutExt</var> - returns just the name of the file without an extension</short>
<errors/>
<seealso/>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="ExtractFileNameWithoutExt.Result"> <element name="ExtractFileNameWithoutExt.Result">
<short/> <short>Returns the original file name if it had no extension, otherwise returns the file name with its extension removed</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="ExtractFileNameWithoutExt.AFilename"> <element name="ExtractFileNameWithoutExt.AFilename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="CompareFileExt"> <element name="CompareFileExt">
@ -408,25 +424,30 @@
<short> <short>
<var>CaseSensitive</var> - if True, case of <var>CaseSensitive</var> - if True, case of
<var>Ext</var> must match case in <var>Ext</var> must match case in
<var>FileName</var> <var>FileName</var>
</short> </short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="FilenameIsPascalUnit"> <element name="FilenameIsPascalUnit">
<short/> <short>
<descr/> <var>FilenameIsPascalUnit</var> - checks that the supplied name is a correct Pascal unit name</short>
<errors/> <descr>
<seealso/> <p>
<var>FilenameIsPascalUnit</var> - checks that the supplied name is a correct Pascal unit name</p>
<p>Looks at the file extension to see if it matches one of the standard Pascal extensions (currently .p, .pp, .pas)</p>
</descr>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="FilenameIsPascalUnit.Result"> <element name="FilenameIsPascalUnit.Result">
<short/> <short>Returns True if the supplied name is a correct Pascal Unit filename</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="FilenameIsPascalUnit.Filename"> <element name="FilenameIsPascalUnit.Filename">
<short/> <short>The name of the file for checking</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="AppendPathDelim"> <element name="AppendPathDelim">
@ -461,18 +482,16 @@
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="TrimFilename"> <element name="TrimFilename">
<short/> <short>
<descr/> <var>TrimFilename</var> - trim double path delimiters, heading and trailing spaces and special dirs . and ..</short>
<errors/>
<seealso/>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TrimFilename.Result"> <element name="TrimFilename.Result">
<short/> <short>Returns the original file name if no trimming was needed, otherwise returns the trimmed file name</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TrimFilename.AFilename"> <element name="TrimFilename.AFilename">
<short/> <short>The name of the file for trimming</short>
</element> </element>
<!-- function Visibility: default --> <!-- function Visibility: default -->
<element name="CleanAndExpandFilename"> <element name="CleanAndExpandFilename">
@ -508,14 +527,18 @@
<element name="CreateAbsoluteSearchPath"> <element name="CreateAbsoluteSearchPath">
<short> <short>
<var>CreateAbsoluteSearchPath</var> - concatenates <var>CreateAbsoluteSearchPath</var> - concatenates
<var>BaseDirectory </var>and <var>BaseDirectory </var>and
<var>SearchPath</var> to form an absolute path to search for files</short> <var>SearchPath</var> to form an absolute path to search for files</short>
<descr> <descr>
<p> <p>
<var>CreateAbsoluteSearchPath</var> - concatenates <var>CreateAbsoluteSearchPath</var> - concatenates
<var>BaseDirectory </var>and <var>BaseDirectory </var>and
<var>SearchPath</var> to form an absolute path to search for files</p> <var>SearchPath</var> to form an absolute path to search for files</p>
<p>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.</p> <p>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.</p>
</descr> </descr>
@ -544,10 +567,12 @@
<element name="CreateRelativePath"> <element name="CreateRelativePath">
<short> <short>
<var>CreateRelativePath</var> - given an absolute path and a <var>CreateRelativePath</var> - given an absolute path and a
<var>BaseDirectory,</var> create a search path relative to the current directory</short> <var>BaseDirectory,</var> create a search path relative to the current directory</short>
<descr> <descr>
<p> <p>
<var>CreateRelativePath</var> - given an absolute path and a <var>CreateRelativePath</var> - given an absolute path and a
<var>BaseDirectory,</var> create a search path relative to the current directory</p> <var>BaseDirectory,</var> create a search path relative to the current directory</p>
<p>The returned string includes the correct number of dots and double dots to signify relativity to the current directory (eg ../../or ..\..\ etc)</p> <p>The returned string includes the correct number of dots and double dots to signify relativity to the current directory (eg ../../or ..\..\ etc)</p>
</descr> </descr>