Skip to content

Commit

Permalink
added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
turleypol committed Dec 26, 2020
1 parent 00fdcc6 commit bae244a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
9 changes: 8 additions & 1 deletion docs/docs.polserver.com/pol100/corechanges.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@
<ESCRIPT>
<header>
<topic>Latest Core Changes</topic>
<datemodified>12-17-2020</datemodified>
<datemodified>12-26-2020</datemodified>
</header>
<version name="POL100">
<entry>
<date>12-26-2020</date>
<author>Turley:</author>
<change type="Added">os::GetEnvironmentVariable(name:=&quot;&quot;)<br/>
returns String value of given environment variable name<br/>
if name is empty returns dictionary of all environment variables</change>
</entry>
<entry>
<date>12-17-2020</date>
<author>Turley:</author>
Expand Down
9 changes: 8 additions & 1 deletion docs/docs.polserver.com/pol100/osem.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<ESCRIPT>
<fileheader fname="OS.em">
<filedesc>POL System Environment Functions</filedesc>
<datemodified>12/12/2020</datemodified>
<datemodified>12/26/2020</datemodified>
<constant>// set_script_option constants</constant>
<constant>const SCRIPTOPT_NO_INTERRUPT := 1; // if 1, script runs until it sleeps</constant>
<constant>const SCRIPTOPT_DEBUG := 2; // if 1, prints any debug info included</constant>
Expand Down Expand Up @@ -283,4 +283,11 @@ Example: create a POST request to a REST endpoint with custom header:
<explain>Starts a new script, to be able to later call exported functions. Non-critical or critical depending on the current state of the calling script. Blocks until the program part of the script is finished. See ExportedScript documentation how to call exported functions.</explain>
<related>ExportedScript</related>
</function>

<function name="GetEnvironmentVariable">
<prototype>GetEnvironmentVariable(name:="")</prototype>
<parameter name="name" value="String name of environment variable, or empty string" />
<return>String value of given enviroment variable, or if no name is given Dictionary{String, String}</return>
<explain>Returns the value of given environment variable, or if no name is given it returns a dictionary with all environment variables</explain>
</function>
</ESCRIPT>
4 changes: 4 additions & 0 deletions pol-core/doc/core-changes.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
-- POL100 --
12-26-2020 Turley:
Added: os::GetEnvironmentVariable(name:="")
returns String value of given environment variable name
if name is empty returns dictionary of all environment variables
12-17-2020 Turley:
Added: AppendConfigFileElem now checks if the file could be opened, returns an error if this fails.
12-9-2020 Turley:
Expand Down

0 comments on commit bae244a

Please sign in to comment.