Differences

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

--- syntax:functions:system [2018/08/13 15:44] – dmitry
+++ syntax:functions:system [2021/07/31 03:01] – craigt
@@ Line 1: / Line 1: @@
-===== System(keyword) =====
+====== System(keyword) ======
+Category:  Special function
-Returns system values. They keyword must be a text constant. Reference to a field or parameter not allowed.
+\\
+=====Description=====
+This function returns the system value specified by the //keyword// argument.  The //keyword// must be a text constant from the table below and may not be a data field reference or parameter.
-Currently supported keywords:
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|keyword|Text  |One of the text constants from the table below specifying the system data desired.  |
+**Return value type:** Text (one of the Result values from the table below)
+\\
+====Currently supported keywords:====
 ^  Keyword  ^  Result  ^
 | user |The current Windows user. |
-| projectpath |The full path to the current project including file name. |
+| projectpath |The full path to the current project, including file name. |
-| projectfilename |Current project’s file name only, without extension. |
+| projectfilename |The current project’s file name only, without the extension. |
-| projectdir |Current project’s directory. |
+| projectdir |The current project’s directory. |
-| callerpath |The full path to the calling project ((The calling project is the project that contains the [[transformations:call|Call]] or [[transformations:iterate|Iterate]] transformation that called the current project)) including file name. |
+| callerpath |The full path to the calling project ((The calling project is the project that contains the [[transformations:call|Call]] or [[transformations:iterate|Iterate]] action that called the current project))  including file name. |
-| callerfilename |The directory of the calling project. |
+| callerfilename |The file name (without extension) of the calling project. |
 | programdir |The full path to morph.exe. |
 | currentdir |The working directory. |
 | utcoffset |The UTC offset to the system time zone ( e.g. "-04:00:00"). |
 | tempdir |The current temporary directory. |
-| projectappversion|The version of application that created current project |
+| projectappversion|The version of the application that created current project |
-**Example**
+\\
-^  Example  ^  Result  ^
+=====Examples=====
-| system('projectpath')  |C:\Documents\myproject.morph |
-**See also**
+  system('projectpath') = "C:\Documents\myproject.morph"
+  system('projectfilename') = "myproject.morph"
-  * [[syntax:functions:today]]
-  * [[syntax:functions:now]]
+\\
+=====See also=====
+  * [[syntax:functions:metadata|Metadata(keyword)]]
+  * [[syntax:functions:now|Now()]]
+  * [[syntax:functions:today|Today()]]