X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref.sgml;h=6b794780a597b65a281d9797d9656b44053be9bc;hb=5d0f4d69b681b5dc15ac423442de2596da9e36d9;hp=2fbf5ddcf6d70b28e52246815abb7f60a408a30a;hpb=8689e2bd1712c080698d2c864ea62245deaccbc5;p=uffi.git
diff --git a/doc/ref.sgml b/doc/ref.sgml
index 2fbf5dd..6b79478 100644
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -330,15 +330,86 @@ always need to have memory for them.
Libraries
-
- load-foreign-library
-
- This function loads foreign libraries. It has checks to
- ensure that a library is loaded only once during a session.
-
-
-
-
+
+
+ load-foreign-library
+ Loads a foreign library.
+
+ Function
+
+
+ Syntax
+
+ load-foreign-library filename module supporting-libraries => success
+
+
+
+ Arguments and Values
+
+
+ filename
+
+ A string or pathname specifying the library location
+in the filesystem.
+
+
+
+
+ module
+
+ A string designating the name of the module to apply
+to functions in this library. (Required for Lispworks)
+
+
+
+
+ supporting-libraries
+
+ A list of strings naming the libraries required to
+link the foreign library. (Required by CMUCL)
+
+
+
+
+ success
+
+ A boolean flag, &t; if the library was able to be
+loaded successfully or if the library has been previously loaded,
+otherwise &nil;.
+
+
+
+
+
+
+ Description
+ Loads a foreign library. Applies a module name to functions
+within the library. Ensures that a library is only loaded once during
+a session.
+
+
+
+ Examples
+
+ (load-foreign-library #p"/usr/lib/libmysqlclient.so" "mysql" '("c"))
+ => T
+
+
+
+ Side Effects
+ Loads the foreign code into the Lisp system.
+
+
+
+ Affected by
+ Ability to load the file.
+
+
+ Exceptional Situations
+ None.
+
+
+