diff --git a/docs/xml/lazutils/lazfileutils.xml b/docs/xml/lazutils/lazfileutils.xml index 7297b4a9fc..992297d80d 100644 --- a/docs/xml/lazutils/lazfileutils.xml +++ b/docs/xml/lazutils/lazfileutils.xml @@ -1634,23 +1634,64 @@ needed. -Adds a trailing path delimiter when needed. +Adds a trailing path delimiter to the specified path (when needed).

-AppendPathDelim is a String function used to ensure -that a trailing path delimiter is included in the specified Path. The return -value includes the value in Path and the trailing path delimiter (when -needed). +AppendPathDelim is a String function used to ensure that +a trailing path delimiter is included in the specified Path. +AppendPathDelim adds the platform-specific character in PathDelim to the end of +Path if it is not an empty string, and does not already end with one of the +values in AllowDirectorySeparators. +

+

+The return value contains the path with the added trailing path delimiter +character, or the unmodified value in Path if a path delimiter was not added in +the routine. +

+

+AppendPathDelim does not perform any type of resolution, expansion, or +validation of the value passed in Path. Use routines like ExpandFileName(), +DirectoryExists(), or FileExists() to perform these actions for a given path +value. For UTF-8-enabled paths use ExpandFileNameUTF8(), FileExistsUTF8(), or +DirectoryExistsUTF8(). +

+

+Use ChompPathDelim to remove a trailing path delimiter from a specified path. +

+

+Windows +

+

+Please note that a value like 'C:' in Path results in 'C:\' in the return +value. AppendPathDelim does not access the disk device to determine the +per-device current directory; it simply appends the trailing path delimiter to +the return value.

- + + + + + +DirectoryExists +ExpandFileName +ExtractFilePath +FileExists +PathDelim +DirectorySeparator +AllowDirectorySeparators +
-Path value with a trailing path delimiter. + +A path value which includes a trailing path delimiter. + -Path value to examine. + +Path value examined in the routine. +