Debian Codegraph @

docsrc/xlisp/xlisp-doc/reference/symbol-plist.htm

raw
1 <html><head><title>XLISP symbol-plist</title>
2
3 <link rel="stylesheet" type="text/css" href="reference.css">
4
5 </head>
6
7 <body>
8
9 <a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
10 <a href="../manual/contents.htm">Contents</a> |
11 <a href="../tutorials/tutorials.htm">Tutorials</a> |
12 <a href="../examples/examples.htm">Examples</a> |
13 <a href="reference-index.htm">Reference</a>
14
15 <hr>
16
17 <h1>symbol-plist</h1>
18
19 <hr>
20
21 <p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
22 <tr valign="top">
23 <td><nobr>Type:</nobr></td>
24 <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
25 <td width="100%"><nobr>function (subr)</nobr></td>
26 </tr>
27 <tr valign="top">
28 <td><nobr>Source:</nobr></td>
29 <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
30 <td width="100%"><nobr> xlbfun.c</nobr></td>
31 </tr>
32 </tbody></table></p>
33
34 <h2>Syntax</h2>
35
36 <dl>
37 <dt>(symbol-plist <i>symbol</i>)</dt>
38 <dd><i>symbol</i> - the symbol name with a property list<br>
39 returns - the symbol's property list </dd>
40 </dl>
41
42 <h2>Description</h2>
43
44 <p>The 'symbol-plist' function returns the actual property list from the
45 'symbol'. The 'symbol' must be an existing, bound variable, but it does not
46 need to have anything in it's property list.</p>
47
48 <p>Property lists are lists attached to any user defined variables. The lists
49 are in the form of:</p>
50
51 <pre class="example">
52 (<font color="#008844"><i>name1 val1 name2 val2</i></font> ....)
53 </pre>
54
55 <p>Any number of properties may be attached to a single variable.</p>
56
57 <h2>Examples</h2>
58
59 <pre class="example">
60 (setq person 'bobby) <font color="#008844">; create a var with a value</font>
61 (putprop person 'boogie 'last-name) <font color="#008844">; add a LAST-NAME property</font>
62 (putprop person 'disc-jockey 'job) <font color="#008844">; add a JOB property</font>
63 (putprop person '(10 20 30) 'stats) <font color="#008844">; add a STATS list</font>
64
65 (symbol-plist person) <font color="#008844">; returns the property list:</font>
66 <font color="#008844">; (STATS (10 20 30)</font>
67 <font color="#008844">; JOB DISC-JOCKEY</font>
68 <font color="#008844">; LAST-NAME BOOGIE)</font>
69 </pre>
70
71 <p>See the
72 <a href="../manual/xlisp-man-013.htm#symbol-plist">symbol-plist</a>
73 function in the <nobr>XLISP 2.0</nobr> manual.</p>
74
75 <p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>
76
77 <hr>
78
79 <a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
80 <a href="../manual/contents.htm">Contents</a> |
81 <a href="../tutorials/tutorials.htm">Tutorials</a> |
82 <a href="../examples/examples.htm">Examples</a> |
83 <a href="reference-index.htm">Reference</a>
84
85 </body></html>