Differences

This shows you the differences between two versions of the page.

--- syntax:functions:directory [2018/06/11 07:20] – created dmitry
+++ syntax:functions:directory [2021/08/29 00:55] (current) – craigt
@@ Line 1: / Line 1: @@
-===== directory(text) =====
+====== Directory(full_path) ======
+Category:  File function  (found in the "Special" category in the EasyMorph application)
+\\
+=====Description=====
+This function extracts the directory path from a full file path, excluding the file name.
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|full_path  |Text  |A full file path including the directory path and file name.|
+**Return value type:** Text.
+\\
+=====Remarks=====
+Return values containing //only// a root path will include the trailing backslash while non-root paths will //not// include the trailing backslash.  See the "Examples" section below.
+When a relative reference is used in a rooted path, only the dot or double-dot is returned //without// the trailing backslash.  See the "Examples" section below.
+\\
+=====Examples=====
+  directory('C:\myproject.morph')  //Returns 'C:\'  (Root paths include a backslash.)
+  directory('C:\Documents\myproject.morph')  //Returns 'C:\Documents'  (No trailing backslash for non-root paths.)
+  directory('..\myproject.morph') //Returns '..' (Rooted relative reference excludes the backslash.)
+  directory('..\MyProjects\March\myproject.morph') //Returns '..\MyProjects\March' (Relative reference)
+\\
+=====See also=====
+  * [[syntax:functions:fileextension|FileExtension(full_path)]]
+  * [[syntax:functions:filename|FileName(full_path)]]
-Extracts the full directory path from a full file path.
-^  Example  ^  Result  ^  Notes  ^
-| directory('C:\Documents\myproject.morph')  |C:\Documents | No trailing backslash for non-root paths.|
-| directory('C:\myproject.morph')  |C:\ | Root paths have a backslash|