uffi/doc ref.sgml,1.31,1.32

Update of /pubcvs/uffi/doc
In directory boa.b9.com:/tmp/cvs-serv8519

Modified Files:
	ref.sgml 
Log Message:



Index: ref.sgml
===================================================================
RCS file: /pubcvs/uffi/doc/ref.sgml,v
retrieving revision 1.31
retrieving revision 1.32
diff -C2 -d -r1.31 -r1.32
*** ref.sgml	28 Jun 2002 21:09:42 -0000	1.31
--- ref.sgml	22 Nov 2002 01:33:18 -0000	1.32
***************
*** 1496,1505 ****
  <title>Overview</title>
  <para>
! 	  &uffi; has functions to two types of <varname>C</varname>-compatible 
  	  strings, <emphasis>cstring</emphasis> and <emphasis>foreign</emphasis> strings.
! cstrings are used as parameters to and from functions. An implementation, such as CMUCL,
! may not convert these to a foreign type for efficiency sake. Thus, it is not
! possible to "allocate" a cstring. In contrast, foreign strings
! always need to have memory for them.
  	</para>
  </partintro>
--- 1496,1516 ----
  <title>Overview</title>
  <para>
! 
! 	  &uffi; has functions to two types of
! <varname>C</varname>-compatible
  	  strings, <emphasis>cstring</emphasis> and <emphasis>foreign</emphasis> strings.
! 
! cstrings are used as parameters to and from functions. An
! implementation, such as CMUCL and Lispworks, a cstring may not be a
! foreign type but rather the Lisp string itself while on other
! platforms a cstring is a newly allocated foreign vector for storing
! characters. Thus, it is not possible to portably
! <emphasis>allocate</emphasis> a cstring. 
! </para>
! <para>
! In contrast, foreign strings
! are always a foreign vector of characters which have a memory
! allocated to hold them. Because of this, if you need to allocate memory to
! hold the return value of a string, use a foreign string and not a cstring.
  	</para>
  </partintro>
***************
*** 1603,1607 ****
        <refsect1>
  	<title>Side Effects</title>
! 	<para>None.</para>
        </refsect1>
        <refsect1>
--- 1614,1618 ----
        <refsect1>
  	<title>Side Effects</title>
! 	<para>On some implementations, this function allocates memory.</para>
        </refsect1>
        <refsect1>
***************
*** 1705,1709 ****
  	<title>Description</title>
  	<para>
! 	  Binds a lexical variable to a newly allocated <varname>cstring</varname>. Automatically frees <varname>cstring</varname>.
  	</para>
        </refsect1>
--- 1716,1720 ----
  	<title>Description</title>
  	<para>
! 	  Binds a symbol to a cstring created from conversion of a string. Automatically frees the <varname>cstring</varname>.
  	</para>
        </refsect1>