Nasal library/os.path: Difference between revisions

Nasal library/os.path (view source)

Revision as of 21:09, 11 February 2018

927 bytes added , 11 February 2018

no edit summary

Red Leader

Administrators

2,732

edits

@@ Line 15: / Line 15: @@
 ==== new() ====
 {{Nasal doc
-|syntax = geo.Coord.new(path);
+|syntax = os.path.new([path]);
-|text = Constructor function. Returns a new <code>os.path</code> instance.
+|text = Constructor function. Returns a new <code>os.path</code> instance. Note that the path must not violate the rules for allowed paths.
 |param1 = path
-|param1text = A string pointing to a filepath.
+|param1text = Optional string specifying the filepath. If not given, the path will default to [[$FG_ROOT]]
-|example1 = var path = os.path.new("C:/Windows"); # A Windows filepath
+|example1 = var path = os.path.new();
-# var path = os.path.new("/usr/bin/"); # A Unix filepath
+print(path.realpath); # will print $FGROOT
+|example2 = var path = os.path.new("C:/Windows"); # Windows filepath
+# var path = os.path.new("/usr/bin/"); # Unix filepath
 print(path.realpath);
 }}
 ==== set() ====
+{{Nasal doc
+|syntax = os.path.set([path]);
+|text = Sets the filepath. Note that the path must not violate the rules for allowed paths.
+|param1 = path
+|param1text = Optional string specifying the filepath. If not given, the path will be set to [[$FG_ROOT]]
+|example1 = var path = os.path.new("C:/Windows");
+# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
+print(path.realpath);
+path.set();
+print(path.realpath); # will print $FG_ROOT
+|example2 = var path = os.path.new("C:/Windows");
+# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
+print(path.realpath);
+path.set("C:/Windows/Program Files");
+# path.set("/usr/bin/"); # alternative Unix filepath
+print(path.realpath); # prints new path
+}}
 ==== append() ====
 ==== concat() ====