TryCreateRelativePath

Attempts to create a path in Dest relative the path in Source.

Declaration

Source position: lazfileutils.pas line 67

Description

Returns True if it is possible to create a relative path from Source to Dest Function must be thread safe, so no expanding of filenames is done, since this is not thread-safe (at least on Windows platform).

• Dest and Source must either be both absolute filenames, or relative
• Dest and Source cannot contain '..' since no expanding is done by design
• Dest and Source must be on same drive or UNC path (Windows)
• If both Dest and Source are relative they must at least share their base directory
• Double PathDelims are ignored (unless they are part of the UNC convention)
• If UsePointDirectory is True and Result is True then if RelPath is Empty string, RelPath becomes '.'
• If AlwaysRequireSharedBaseFolder is False then Absolute filenames need not share a basefolder
• if the function succeeds RelPath contains the relative path from Source to Dest, no PathDelimiter is appended to the end of RelPath

Examples:

- Dest = /foo/bar Source = /foo Result =  RelPath = bar
- Dest = /foo///bar Source = /foo// Result =  RelPath = bar
- Dest = /foo Source = /foo/bar Result =  RelPath = ../
- Dest = /foo/bar Source = /bar Result =  RelPath = ../foo/bar
- Dest = foo/bar Source = foo/foo Result =  RelPath = ../bar
- Dest = foo/bar Source = bar/foo Result =  (no shared base directory)
- Dest = /foo Source = bar Result =  (mixed absolute and relative)
- Dest = c:foo Source = c:bar Result =  (no expanding)
- Dest = c:\foo Source = d:\bar Result is  (different drives)
- Dest = \foo Source = foo (Windows) Result is  (too ambiguous to guess what this should mean)
- Dest = /foo Source = /bar AlwaysRequireSharedBaseFolder =  Result = False
- Dest = /foo Source = /bar AlwaysRequireSharedBaseFolder =  Result =  RelPath = ../foo