/usr/share/doc/cl-uffi/html/def-function.html is in cl-uffi 2.1.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>def-function</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="UFFI Reference Guide" /><link rel="up" href="func_libr.html" title="Functions & Libraries" /><link rel="prev" href="func_libr.html" title="Functions & Libraries" /><link rel="next" href="load-foreign-library.html" title="load-foreign-library" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">def-function</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="func_libr.html">Prev</a> </td><th width="60%" align="center">Functions & Libraries</th><td width="20%" align="right"> <a accesskey="n" href="load-foreign-library.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="def-function"><a id="def-function"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>def-function — Declares a function.
<b>Macro</b></p></div><div class="refsynopsisdiv" title="Syntax"><h2>Syntax</h2><pre class="synopsis">
<code class="function">def-function</code> <em class="replaceable"><code>name args &key module returning</code></em>
</pre></div><div class="refsect1" title="Arguments and Values"><a id="id380512"></a><h2>Arguments and Values</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>A string or list specificying the function name. If it is a string, that names the foreign function. A Lisp name is created by translating #\_ to #\- and by converting to upper-case in case-insensitive Lisp implementations. If it is a list, the first item is a string specifying the foreign function name and the second it is a symbol stating the Lisp name.
</p></dd><dt><span class="term"><em class="parameter"><code>args</code></em></span></dt><dd><p>A list of argument declarations. If <code class="constant">NIL</code>, indicates that the function does not take any arguments.
</p></dd><dt><span class="term"><em class="parameter"><code>module</code></em></span></dt><dd><p>A string specifying which module (or library) that the foreign function resides. (Required by Lispworks)</p></dd><dt><span class="term"><span class="returnvalue">returning</span></span></dt><dd><p>A declaration specifying the result type of the
foreign function. If <code class="constant">:void</code> indicates module does not return any value.
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id383172"></a><h2>Description</h2><p>Declares a foreign function.
</p></div><div class="refsect1" title="Examples"><a id="id383183"></a><h2>Examples</h2><pre class="screen">
(def-function "gethostname"
((name (* :unsigned-char))
(len :int))
:returning :int)
</pre></div><div class="refsect1" title="Side Effects"><a id="id383197"></a><h2>Side Effects</h2><p>None.</p></div><div class="refsect1" title="Affected by"><a id="id383208"></a><h2>Affected by</h2><p>None.</p></div><div class="refsect1" title="Exceptional Situations"><a id="id383219"></a><h2>Exceptional Situations</h2><p>None.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="func_libr.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="func_libr.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="load-foreign-library.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Functions & Libraries </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> load-foreign-library</td></tr></table></div></body></html>
|