1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/f_symb_5.htm

91 lines
5.6 KiB
HTML
Raw Normal View History

2024-04-01 10:24:07 +02:00
<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
<HTML>
<HEAD>
<TITLE>CLHS: Accessor SYMBOL-VALUE</TITLE>
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
<LINK REL=TOP HREF="../Front/index.htm">
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
<LINK REL=PREV HREF="f_symb_4.htm">
<LINK REL=UP HREF="c_symbol.htm">
<LINK REL=NEXT HREF="f_get.htm">
</HEAD>
<BODY>
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="f_symb_4.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_symbol.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_get.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="symbol-value"><I>Accessor</I> <B>SYMBOL-VALUE</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>symbol-value</B> <I>symbol</I> =&gt; <I>value</I><P>
<TT>(setf (</TT><B>symbol-value</B> <I>symbol</I><TT>) </TT><I>new-value</I><TT>)</TT><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>symbol</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> that must have a <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A>. <P>
<I>value</I>, <I>new-value</I>---an <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="26_glo_a.htm#access"><I>Accesses</I></A> the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>'s <A REL=DEFINITION HREF="26_glo_v.htm#value_cell"><I>value cell</I></A>. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(setf (symbol-value 'a) 1) =&gt; 1
(symbol-value 'a) =&gt; 1
;; SYMBOL-VALUE cannot see lexical variables.
(let ((a 2)) (symbol-value 'a)) =&gt; 1
(let ((a 2)) (setq a 3) (symbol-value 'a)) =&gt; 1
;; SYMBOL-VALUE can see dynamic variables.
(let ((a 2))
(declare (special a))
(symbol-value 'a)) =&gt; 2
(let ((a 2))
(declare (special a))
(setq a 3)
(symbol-value 'a)) =&gt; 3
(let ((a 2))
(setf (symbol-value 'a) 3)
a) =&gt; 2
a =&gt; 3
(symbol-value 'a) =&gt; 3
(let ((a 4))
(declare (special a))
(let ((b (symbol-value 'a)))
(setf (symbol-value 'a) 5)
(values a b))) =&gt; 5, 4
a =&gt; 3
(symbol-value :any-keyword) =&gt; :ANY-KEYWORD
(symbol-value 'nil) =&gt; NIL
(symbol-value '()) =&gt; NIL
;; The precision of this next one is <A REL=DEFINITION HREF="26_glo_i.htm#implementation-dependent">implementation-dependent</A>.
(symbol-value 'pi) =&gt; 3.141592653589793d0
</PRE>
</TT> <P>
<P><B>Side Effects:</B> None.
<P>
<P><B>Affected By:</B><P>
<P>
<A REL=DEFINITION HREF="f_makunb.htm#makunbound"><B>makunbound</B></A>, <A REL=DEFINITION HREF="f_set.htm#set"><B>set</B></A>, <A REL=DEFINITION HREF="s_setq.htm#setq"><B>setq</B></A> <P>
<P><B>Exceptional Situations:</B><P>
<P>
Should signal an error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_tp_err.htm#type-error"><B>type-error</B></A> if <I>symbol</I> is not a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>. <P>
Should signal <A REL=DEFINITION HREF="e_unbo_1.htm#unbound-variable"><B>unbound-variable</B></A> if <I>symbol</I> is <A REL=DEFINITION HREF="26_glo_u.htm#unbound"><I>unbound</I></A> and an attempt is made to <A REL=DEFINITION HREF="26_glo_r.htm#read"><I>read</I></A> its <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A>. (No such error is signaled on an attempt to <A REL=DEFINITION HREF="26_glo_w.htm#write"><I>write</I></A> its <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A>.) <P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_boundp.htm#boundp"><B>boundp</B></A>, <A REL=DEFINITION HREF="f_makunb.htm#makunbound"><B>makunbound</B></A>, <A REL=DEFINITION HREF="f_set.htm#set"><B>set</B></A>, <A REL=DEFINITION HREF="s_setq.htm#setq"><B>setq</B></A> <P>
<P><B>Notes:</B><P>
<P>
<A REL=DEFINITION HREF="#symbol-value"><B>symbol-value</B></A> can be used to get the value of a <A REL=DEFINITION HREF="26_glo_c.htm#constant_variable"><I>constant variable</I></A>. <A REL=DEFINITION HREF="#symbol-value"><B>symbol-value</B></A> cannot <A REL=DEFINITION HREF="26_glo_a.htm#access"><I>access</I></A> the value of a <A REL=DEFINITION HREF="26_glo_l.htm#lexical_variable"><I>lexical variable</I></A>. <P>
<HR>
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
</BODY>
</HTML>