61 lines
5.8 KiB
HTML
61 lines
5.8 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 APROPOS, APROPOS-LIST</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_sleep.htm">
|
||
|
|
<LINK REL=UP HREF="c_enviro.htm">
|
||
|
|
<LINK REL=NEXT HREF="f_descri.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_sleep.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_enviro.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_descri.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="apropos"><A NAME="apropos-list"><I>Function</I> <B>APROPOS, APROPOS-LIST</B></A></A> <P>
|
||
|
|
<P><B>Syntax:</B><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>apropos</B> <I>string <TT>&optional</TT> package</I> => <I><I><no values></I></I><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>apropos-list</B> <I>string <TT>&optional</TT> package</I> => <I>symbols</I><P>
|
||
|
|
<P>
|
||
|
|
<P><B>Arguments and Values:</B><P>
|
||
|
|
<P>
|
||
|
|
<I>string</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string_designator"><I>string designator</I></A>. <P>
|
||
|
|
<I>package</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#package_designator"><I>package designator</I></A> or <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. The default is <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
||
|
|
<I>symbols</I>---a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A> of <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A>. <P>
|
||
|
|
<P><B>Description:</B><P>
|
||
|
|
<P>
|
||
|
|
These functions search for <A REL=DEFINITION HREF="26_glo_i.htm#interned"><I>interned</I></A> <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>names</I></A> contain the substring <I>string</I>. <P>
|
||
|
|
For <A REL=DEFINITION HREF="#apropos"><B>apropos</B></A>, as each such <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> is found, its name is printed on <A REL=DEFINITION HREF="26_glo_s.htm#standard_output"><I>standard output</I></A>. In addition, if such a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> is defined as a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> or <A REL=DEFINITION HREF="26_glo_d.htm#dynamic_variable"><I>dynamic variable</I></A>, information about those definitions might also be printed. <P>
|
||
|
|
For <A REL=DEFINITION HREF="#apropos-list"><B>apropos-list</B></A>, no output occurs as the search proceeds; instead a list of the matching <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> is returned when the search is complete. <P>
|
||
|
|
If <I>package</I> is <A REL=DEFINITION HREF="26_glo_n.htm#non-nil"><I>non-nil</I></A>, only the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#accessible"><I>accessible</I></A> in that <I>package</I> are searched; otherwise all <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#accessible"><I>accessible</I></A> in any <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>package</I></A> are searched. <P>
|
||
|
|
Because a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> might be available by way of more than one inheritance path, <A REL=DEFINITION HREF="#apropos"><B>apropos</B></A> might print information about the <A REL=DEFINITION HREF="26_glo_s.htm#same"><I>same</I></A> <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> more than once, or <A REL=DEFINITION HREF="#apropos-list"><B>apropos-list</B></A> might return a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A> containing duplicate <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A>. <P>
|
||
|
|
Whether or not the search is case-sensitive is <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A>. <P>
|
||
|
|
<P><B>Examples:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Affected By:</B><P>
|
||
|
|
<P>
|
||
|
|
The set of <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> which are currently <A REL=DEFINITION HREF="26_glo_i.htm#interned"><I>interned</I></A> in any <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>packages</I></A> being searched. <P>
|
||
|
|
<A REL=DEFINITION HREF="#apropos"><B>apropos</B></A> is also affected by <A REL=DEFINITION HREF="v_debug_.htm#STstandard-outputST"><B>*standard-output*</B></A>. <P>
|
||
|
|
<P><B>Exceptional Situations:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>See Also:</B> None.
|
||
|
|
<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>
|