66 lines
5 KiB
HTML
66 lines
5 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: Function GET-PROPERTIES</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_rassoc.htm">
|
|
<LINK REL=UP HREF="c_conses.htm">
|
|
<LINK REL=NEXT HREF="f_getf.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_rassoc.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_getf.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="get-properties"><I>Function</I> <B>GET-PROPERTIES</B></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>get-properties</B> <I>plist indicator-list</I> => <I>indicator, value, tail</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>plist</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#property_list"><I>property list</I></A>. <P>
|
|
<I>indicator-list</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#proper_list"><I>proper list</I></A> (of <A REL=DEFINITION HREF="26_glo_i.htm#indicator"><I>indicators</I></A>). <P>
|
|
<I>indicator</I>---an <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A> that is an <A REL=DEFINITION HREF="26_glo_e.htm#element"><I>element</I></A> of <I>indicator-list</I>. <P>
|
|
<I>value</I>---an <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A>. <P>
|
|
<I>tail</I>---a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="#get-properties"><B>get-properties</B></A> is used to look up any of several <A REL=DEFINITION HREF="26_glo_p.htm#property_list"><I>property list</I></A> entries all at once. <P>
|
|
It searches the <I>plist</I> for the first entry whose <A REL=DEFINITION HREF="26_glo_i.htm#indicator"><I>indicator</I></A> is <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> to one of the <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>objects</I></A> in <I>indicator-list</I>. If such an entry is found, the <I>indicator</I> and <I>value</I> returned are the <A REL=DEFINITION HREF="26_glo_p.htm#property_indicator"><I>property indicator</I></A> and its associated <A REL=DEFINITION HREF="26_glo_p.htm#property_value"><I>property value</I></A>, and the <I>tail</I> returned is the <A REL=DEFINITION HREF="26_glo_t.htm#tail"><I>tail</I></A> of the <I>plist</I> that begins with the found entry (i.e., whose <A REL=DEFINITION HREF="26_glo_c.htm#car"><I>car</I></A> is the <I>indicator</I>). If no such entry is found, the <I>indicator</I>, <I>value</I>, and <I>tail</I> are all <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
|
<P><B>Examples:</B><P>
|
|
<P>
|
|
<PRE>
|
|
(setq x '()) => NIL
|
|
(setq *indicator-list* '(prop1 prop2)) => (PROP1 PROP2)
|
|
(getf x 'prop1) => NIL
|
|
(setf (getf x 'prop1) 'val1) => VAL1
|
|
(eq (getf x 'prop1) 'val1) => <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
|
|
(get-properties x *indicator-list*) => PROP1, VAL1, (PROP1 VAL1)
|
|
x => (PROP1 VAL1)
|
|
</PRE>
|
|
</TT> <P>
|
|
<P><B>Side Effects:</B> None.
|
|
<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_get.htm#get"><B>get</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 issue</A>, <I>not part of the specification</I>, applies to this section:<P><UL><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>
|