File: GETENV%24.html

package info (click to toggle)
acl2 3.1-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 36,712 kB
  • ctags: 38,396
  • sloc: lisp: 464,023; makefile: 5,470; sh: 86; csh: 47; cpp: 25; ansic: 22
file content (27 lines) | stat: -rw-r--r-- 1,152 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<html>
<head><title>GETENV$.html  --  ACL2 Version 3.1</title></head>
<body text=#000000 bgcolor="#FFFFFF">
<h2>GETENV$</h2>read an environment variable
<pre>Major Section:  <a href="PROGRAMMING.html">PROGRAMMING</a>
</pre><p>

<code>(Getenv$ str)</code>, where <code>str</code> is a string, reads the value of
environment variable <code>str</code>, returning <code>nil</code> if none is found or if the
read fails.  The formal story is that <code>getenv$</code> reads its value from the
<code>oracle</code> field of the ACL2 <code><a href="STATE.html">state</a></code>.  The return value is thus a triple
of the form <code>(mv erp val state)</code>, where <code>erp</code> will always be <code>nil</code> in
practice, <code>val</code> is the value that has been read, and <code>state</code> is the new
state, which is obtained by popping <code>val</code> from the top of the state's
oracle.

<pre>
Example:
(getenv$ "PWD") ==&gt; (mv nil "/u/joe/work" state)
</pre>

Also see <a href="SETENV$.html">setenv$</a>.
<p>

<br><br><br><a href="acl2-doc.html"><img src="llogo.gif"></a> <a href="acl2-doc-index.html"><img src="index.gif"></a>
</body>
</html>