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

78 lines
4.4 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: Standard Generic Function FUNCTION-KEYWORDS</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="c_object.htm">
<LINK REL=UP HREF="c_object.htm">
<LINK REL=NEXT HREF="f_ensure.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="c_object.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_object.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_ensure.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="function-keywords"><I>Standard Generic Function</I> <B>FUNCTION-KEYWORDS</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>function-keywords</B> <I>method</I> =&gt; <I>keys, allow-other-keys-p</I><P>
<P>
<P><B>Method Signatures:</B><P>
<P>
<B>function-keywords</B> <I>(<I>method</I><B> <A REL=DEFINITION HREF="t_std_me.htm#standard-method">standard-method</A></B>)</I><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>method</I>---a <A REL=DEFINITION HREF="26_glo_m.htm#method"><I>method</I></A>. <P>
<I>keys</I>---a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A>. <P>
<I>allow-other-keys-p</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. <P>
<P><B>Description:</B><P>
<P>
Returns the keyword parameter specifiers for a <I>method</I>. <P>
Two values are returned: a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A> of the explicitly named keywords and a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A> that states whether <TT>&amp;allow-other-keys</TT> had been specified in the <I>method</I> definition. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(defmethod gf1 ((a integer) &amp;optional (b 2)
&amp;key (c 3) ((:dee d) 4) e ((eff f)))
(list a b c d e f))
=&gt; #&lt;STANDARD-METHOD GF1 (INTEGER) 36324653&gt;
(find-method #'gf1 '() (list (find-class 'integer)))
=&gt; #&lt;STANDARD-METHOD GF1 (INTEGER) 36324653&gt;
(function-keywords *)
=&gt; (:C :DEE :E EFF), <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(defmethod gf2 ((a integer))
(list a b c d e f))
=&gt; #&lt;STANDARD-METHOD GF2 (INTEGER) 42701775&gt;
(function-keywords (find-method #'gf1 '() (list (find-class 'integer))))
=&gt; (), <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(defmethod gf3 ((a integer) &amp;key b c d &amp;allow-other-keys)
(list a b c d e f))
(function-keywords *)
=&gt; (:B :C :D), <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
</PRE>
</TT> <P>
<P><B>Affected By:</B><P>
<P>
<A REL=DEFINITION HREF="m_defmet.htm#defmethod"><B>defmethod</B></A> <P>
<P><B>Exceptional Situations:</B> None.
<P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="m_defmet.htm#defmethod"><B>defmethod</B></A> <P>
<P><B>Notes:</B> None.
<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>