<!-- 

     This document is part of the panda distribution, and is covered
     by the GNU GPL, a copy of which is in the file named COPYING inside the
     distribution.

     This program and it's documentation are distributed in the hope that 
     they will be useful,but WITHOUT ANY WARRANTY; without even the implied 
     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
-->

<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">

<refentry id="panda_freeobject">
<refmeta>
<refentrytitle>panda_freeobject</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>

<refnamediv>
<refname>panda_freeobject</refname>
<refpurpose>free the memory used by a previously created object</refpurpose>
</refnamediv>

<refsynopsisdiv>
<synopsis>
 #include&amp;lt;panda/constants.h&amp;gt;
 #include&amp;lt;panda/functions.h&amp;gt;
 void panda_freeobject (panda_pdf *output, panda_object *);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>DESCRIPTION</title>
<para>&lt;command&gt;PANDA INTERNAL&lt;/command&gt;. This function call frees the memory used by an object. It is used during the cleanup process prior to finishing closing a PDF document. Even if a user of the API has added object types to their code, they should not have to call this function, as their objects should be added to the object tree via &lt;command&gt;panda_addchild&lt;/command&gt;() to ensure they are written to disc by &lt;command&gt;panda_writeobject&lt;/command&gt;() having been traversed by &lt;command&gt;panda_traverseobjects&lt;/command&gt;() at PDF close time.</para>
</refsect1>

<refsect1>
<title>RETURNS</title>
<para>None</para>
</refsect1>

<refsect1>
<title>EXAMPLE</title>
<programlisting>
 #include&amp;lt;panda/constants.h&amp;gt;
 #include&amp;lt;panda/functions.h&amp;gt;
 panda_pdf *document;
 panda_object *obj;
 panda_init();
 document = panda_open("filename.pdf", "w");
 obj = panda_newobject(document, panda_object_normal);
 panda_freeobject(document, obj)l
</programlisting>
</refsect1>

<refsect1>
<title>SEE ALSO</title>
<para>panda_newobject, panda_writeobject, panda_traverseobjects, panda_addchild</para>
</refsect1>


<refsect1>
    <title>VERSION</title>
    <para>
This documentation was generated for <command>Panda</command> 0.5.2 by <command>autodocbook</command> (http://www.stillhq.com).
    </para>
</refsect1>

<refsect1>
    <title>AUTHOR</title>
    <para>
<command>Panda</command> is under development by Michael Still (mikal@stillhq.com). All code is Copyright Michael Still 2000 - 2003,  and is released under the GNU GPL. Code submissions are welcomed. Contact Michael at the address above if you have something you would like to contribute.
</para>
</refsect1>

<refsect1>
    <title>BUGS</title>
    <para>
There  are no known bugs in <command>Panda</command>. If you find one, please contact mikal@stillhq.com and let me know.
</para>
</refsect1>
</refentry>
