X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref.sgml;h=607edfced873810076050e650872e0270ec179d5;hb=d542c08a7adad816d6378fd6c80f62547033b866;hp=732204a47c7f6de8fd3eb8c686a1592333db5681;hpb=8c67076cc94d7f121055288647042003d3ccd4e7;p=uffi.git

diff --git a/doc/ref.sgml b/doc/ref.sgml
index 732204a..607edfc 100644
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -2028,6 +2028,91 @@ a session.
       </refsect1>
     </refentry>
 
+      <refentry id="find-foreign-library">
+	<refnamediv>
+	  <refname>find-foreign-library</refname>
+	<refpurpose>Finds a foreign library file.
+	</refpurpose>
+	<refclass>Function</refclass>
+      </refnamediv>
+      <refsect1>
+	<title>Syntax</title>
+<synopsis>
+	  <function>find-foreign-library</function> <replaceable>names directories &amp; drive-letters types</replaceable> => <returnvalue>path</returnvalue>
+</synopsis>
+      </refsect1>
+      <refsect1>
+	<title>Arguments and Values</title>
+	<variablelist>
+	  <varlistentry>
+	    <term><parameter>names</parameter></term>
+	    <listitem>
+	      <para>A string or list of strings containing the base name of the library file.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>directories</parameter></term>
+	    <listitem>
+	      <para>A string or list of strings containing the directory the library file.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>drive-letters</parameter></term>
+	    <listitem>
+	      <para>A string or list of strings containing the drive letters for the library file.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>A string or list of strings containing the file type of the library file. Default
+is &nil;. If &nil;, will use a default type based on the currently running implementation.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	    <term><returnvalue>path</returnvalue></term>
+	    <listitem>
+	      <para>A path containing the path found, or &nil; if the library file was not found.
+	      </para>
+	    </listitem>
+	  </varlistentry>
+	</variablelist>
+      </refsect1>
+      <refsect1>
+	<title>Description</title>
+	<para>Finds a foreign library by searching through a number of possible locations. Returns
+the path of the first found file.
+	</para>
+      </refsect1>
+      <refsect1>
+	<title>Examples</title>
+	<programlisting>
+(find-foreign-library '("libmysqlclient" "libmysql")
+    '("/opt/mysql/lib/mysql/" "/usr/local/lib/" "/usr/lib/" "/mysql/lib/opt/")
+    :types '("so" "dll")
+    :drive-letters '("C" "D" "E"))
+=> #P"D:\\mysql\\lib\\opt\\libmysql.dll"
+	</programlisting>
+      </refsect1>
+      <refsect1>
+	<title>Side Effects</title>
+	<para>None.
+	</para>
+      </refsect1>
+      <refsect1>
+	<title>Affected by</title>
+	<para>None.</para>
+      </refsect1>
+      <refsect1>
+	<title>Exceptional Situations</title>
+	<para>None.</para>
+      </refsect1>
+    </refentry>
+
 </reference>