paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-21 14:39:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

lcl doc: createrelativepath inverse example

Browse Source 
git-svn-id: trunk@23670 -
This commit is contained in:
mattias 2010-02-09 13:57:39 +00:00
parent 9a1ab2d27c
commit a712ac4139
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -616,7 +616,13 @@
<descr>
<p>
<var>CreateRelativePath</var> - given an absolute path and a <var>BaseDirectory,</var> create a file path relative to the given base 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). The inverse operation is to create an absolute file path:
</p>
<code>RelPath:=CreateRelativePath(AbsPath,BaseDir);
if FilenameIsAbsolute(RelPath) then
NewAbsPath:=RelPath
else
NewAbsPath:=AppendPathDelim(BaseDir)+RelPath;</code>
</descr>
<errors>If <var>BaseDirectory</var> is empty, functions exits and returns with <var>Result</var> equal to <var>Filename</var>; if <var>Filename</var> is empty, function exits with empty <var>Result</var>
</errors>