<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>convert-from-foreign-string</title><link rel="stylesheet" href="ecl.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="The ECL manual"><link rel="up" href="rn04.html" title="Strings"><link rel="prev" href="rn04re72.html" title="with-cstring"><link rel="next" href="rn04re74.html" title="convert-to-foreign-string"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><code class="function">convert-from-foreign-string</code></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="rn04re72.html">Prev</a> </td><th width="60%" align="center">Strings</th><td width="20%" align="right"> <a accesskey="n" href="rn04re74.html">Next</a></td></tr></table><hr></div><div class="refentry" title="convert-from-foreign-string"><a name="uffi.convert-from-foreign-string"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><code class="function">convert-from-foreign-string</code> — Converts a foreign string into a Lisp string.<b>Macro</b></p></div><div class="refsynopsisdiv" title="Syntax"><h2>Syntax</h2><pre class="synopsis">
<code class="function">convert-from-foreign-string</code>
<em class="replaceable"><code>foreign-string &key length null-terminated-p</code></em>
=>
<span class="returnvalue">string</span>
</pre></div><div class="refsect1" title="Arguments and Values"><a name="id694047"></a><h2>Arguments and Values</h2><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>foreign-string</code></em></span></p></td><td><p>A foreign string.
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>length</code></em></span></p></td><td><p>The length of the foreign string to convert. The
default is the length of the string until a <code class="constant">NULL</code>
character is reached.
</p></td></tr><tr><td><p><span class="term"><em class="parameter"><code>null-terminated-p</code></em></span></p></td><td><p>A boolean flag with a default value of <code class="constant">T</code> When true,
the string is converted until the first <code class="constant">NULL</code> character is reached.
</p></td></tr><tr><td><p><span class="term"><span class="returnvalue">string</span></span></p></td><td><p>A Lisp string.
</p></td></tr></tbody></table></div></div><div class="refsect1" title="Description"><a name="id694134"></a><h2>Description</h2><p>
Returns a Lisp string from a foreign string.
Can translated ASCII and binary strings.
</p></div><div class="refsect1" title="Side Effects"><a name="id694144"></a><h2>Side Effects</h2><p>None.</p></div><div class="refsect1" title="Affected by"><a name="id694155"></a><h2>Affected by</h2><p>None.</p></div><div class="refsect1" title="Exceptional Situations"><a name="id694165"></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="rn04re72.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="rn04.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="rn04re74.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="function">with-cstring</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <code class="function">convert-to-foreign-string</code></td></tr></table></div></body></html>
