1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/m_remf.htm
2024-04-01 10:24:07 +02:00

63 lines
5.6 KiB
HTML

<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
<HTML>
<HEAD>
<TITLE>CLHS: Macro REMF</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_getf.htm">
<LINK REL=UP HREF="c_conses.htm">
<LINK REL=NEXT HREF="f_isec_.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_getf.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_conses.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_isec_.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="remf"><I>Macro</I> <B>REMF</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>remf</B> <I>place indicator</I> =&gt; <I>generalized-boolean</I><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>place</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#place"><I>place</I></A>. <P>
<I>indicator</I>---an <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A>. <P>
<I>generalized-boolean</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#remf"><B>remf</B></A> removes from the <A REL=DEFINITION HREF="26_glo_p.htm#property_list"><I>property list</I></A> stored in <I>place</I> a <A REL=DEFINITION HREF="26_glo_p.htm#property"><I>property</I></A>[1] with a <A REL=DEFINITION HREF="26_glo_p.htm#property_indicator"><I>property indicator</I></A> <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> to <I>indicator</I>. If there are multiple <A REL=DEFINITION HREF="26_glo_p.htm#property"><I>properties</I></A>[1] with the <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> key, <A REL=DEFINITION HREF="#remf"><B>remf</B></A> only removes the first such <A REL=DEFINITION HREF="26_glo_p.htm#property"><I>property</I></A>. <A REL=DEFINITION HREF="#remf"><B>remf</B></A> returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A> if no such <A REL=DEFINITION HREF="26_glo_p.htm#property"><I>property</I></A> was found, or <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if a property was found. <P>
The <A REL=DEFINITION HREF="26_glo_p.htm#property_indicator"><I>property indicator</I></A> and the corresponding <A REL=DEFINITION HREF="26_glo_p.htm#property_value"><I>property value</I></A> are removed in an undefined order by destructively splicing the property list. <A REL=DEFINITION HREF="#remf"><B>remf</B></A> is permitted to either <A REL=DEFINITION HREF="m_setf_.htm#setf"><B>setf</B></A> <I>place</I> or to <A REL=DEFINITION HREF="m_setf_.htm#setf"><B>setf</B></A> any part, <A REL=DEFINITION HREF="f_car_c.htm#car"><B>car</B></A> or <A REL=DEFINITION HREF="f_car_c.htm#cdr"><B>cdr</B></A>, of the <A REL=DEFINITION HREF="26_glo_l.htm#list_structure"><I>list structure</I></A> held by that <I>place</I>. <P>
For information about the <A REL=DEFINITION HREF="26_glo_e.htm#evaluation"><I>evaluation</I></A> of <A REL=DEFINITION HREF="26_glo_s.htm#subform"><I>subforms</I></A> of <I>place</I>, see <A REL=CHILD HREF="05_aaa.htm">Section 5.1.1.1 (Evaluation of Subforms to Places)</A>. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(setq x (cons () ())) =&gt; (NIL)
(setf (getf (car x) 'prop1) 'val1) =&gt; VAL1
(remf (car x) 'prop1) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(remf (car x) 'prop1) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
</PRE>
</TT> <P>
<P><B>Side Effects:</B><P>
<P>
The property list stored in <I>place</I> is modified. <P>
<P><B>Affected By:</B> None.
<P>
<P><B>Exceptional Situations:</B> None.
<P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_rempro.htm#remprop"><B>remprop</B></A>, <A REL=DEFINITION HREF="f_getf.htm#getf"><B>getf</B></A> <P>
<P><B>Notes:</B> None.
<P>
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issues</A>, <I>not part of the specification</I>, apply to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss279.htm">PUSH-EVALUATION-ORDER:FIRST-ITEM</A><LI> <A REL=CHILD HREF="../Issues/iss293.htm">REMF-DESTRUCTION-UNSPECIFIED:X3J13-MAR-89</A><LI> <A REL=CHILD HREF="../Issues/iss269.htm">PLIST-DUPLICATES:ALLOW</A><P></UL><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>