<html>
<head>
<title>Eet: Top level functions</title>
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
<meta name="author" content="Andres Blanc" >
<link rel="icon" href="img/favicon.png" type="image/x-icon">
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
<link rel="icon" href="img/favicon.png" type="image/ico">
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
<link rel="stylesheet" type="text/css" media="screen" href="e.css">
<link rel="stylesheet" type="text/css" media="screen" href="edoxy.css">
</head>
<body>
<div id="container">
<div id="header">
<div class="layout">
<h1><span>Enlightenment</span></h1>
<h2><span>Beauty at your fingertips</span></h2>
<div class="menu-container">
<div class="menu">
<ul>
<li class="current"><a href="http://web.enlightenment.org/p.php?p=docs">Docs</a></li>
<li><a href="http://trac.enlightenment.org/e">Tracker</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=contact">Contact</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=support">Support</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=download">Download</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=about">About</a></li>
<li><a href="http://www.enlightenment.org/p.php?p=news">News</a></li>
<li><a href="http://www.enlightenment.org/">Home</a></li>
</ul>
</div>
</div>
<div class="doxytitle">
Eet Documentation <small>at 2 Jul 2010</small>
</div>
<div class="menu-container">
<div class="submenu">
<ul class="current">
<li><a href="Examples.html">Examples</a></li>
<li><a href="files.html">Files</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="globals.html">Globals</a></li>
<li><a href="pages.html">Related Pages</a></li>
<li class="current"><a href="index.html">Main Page</a></li>
</ul>
</div>
</div>
<div class="clear"></div>
</div>
</div>
<div id="content">
<div class="layout">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="contents">
<h1>Top level functions</h1>
<p>Functions that affect Eet as a whole.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab002b16c58e2a62fc7981581647a0092"></a><!-- doxytag: member="Eet_Group::Eet_Error" ref="gab002b16c58e2a62fc7981581647a0092" args="" -->
typedef enum <a class="el" href="group__Eet__Group.html#gaa9142d865094701672375485d4a6284d">_Eet_Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Eet__Group.html#gab002b16c58e2a62fc7981581647a0092">Eet_Error</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Eet error identifiers. <br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Eet__Group.html#gaa9142d865094701672375485d4a6284d">_Eet_Error</a> { <br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da2e3af24c66d0decf7c97fe4e5a7f75d4">EET_ERROR_NONE</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da624f64fe9803c1a4229a60214d675fa4">EET_ERROR_BAD_OBJECT</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da5d7b9168309be93bb29f1b031bad2677">EET_ERROR_EMPTY</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da0cf54c8e55c541d80273ba9297756217">EET_ERROR_NOT_WRITABLE</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284daeffb124373b5049b86ac7e0dbefe53a3">EET_ERROR_OUT_OF_MEMORY</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da27684bc75504112ec1d973dd92b4bc54">EET_ERROR_WRITE_ERROR</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284dad809f5520943b5ddc7a5c2b13d011022">EET_ERROR_WRITE_ERROR_FILE_TOO_BIG</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da161bbe3deff362f178e8cd5dd342f439">EET_ERROR_WRITE_ERROR_IO_ERROR</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da8970e99b686ccb19cac6ce1b522bac46">EET_ERROR_WRITE_ERROR_OUT_OF_SPACE</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da1f63beedf18d69778fe3d09756b0a127">EET_ERROR_WRITE_ERROR_FILE_CLOSED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284daedc70fb84c7eba864adf892b61fa7eed">EET_ERROR_MMAP_FAILED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284daa618d0cf4e95824b9ade43d916cb2661">EET_ERROR_X509_ENCODING_FAILED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da478a6d16452e68c82773dcce92d6374a">EET_ERROR_SIGNATURE_FAILED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da43880471e169e222f29daf7e356dc0e0">EET_ERROR_INVALID_SIGNATURE</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da65f57e87a9554a94c02f0e3d7b82af03">EET_ERROR_NOT_SIGNED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284dab2949e6f94af134c3b1dce154fd15a7d">EET_ERROR_NOT_IMPLEMENTED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da172326f9ccae8830ef27a1f18acc4f19">EET_ERROR_PRNG_NOT_SEEDED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284da04db0378f23672eb778283e2bd0fbd5c">EET_ERROR_ENCRYPT_FAILED</a>,
<br/>
<a class="el" href="group__Eet__Group.html#ggaa9142d865094701672375485d4a6284dad8ea52dac8f5ea43593e530f608edc38">EET_ERROR_DECRYPT_FAILED</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>All the error identifiers known by Eet. </p>
<a href="group__Eet__Group.html#gaa9142d865094701672375485d4a6284d">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Eet__Group.html#ga9903687bfa20fe9a9e59d4c1d213e89a">eet_init</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the EET library. <a href="#ga9903687bfa20fe9a9e59d4c1d213e89a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Eet__Group.html#gacbc7583179399d3b3e7b003e911f866f">eet_shutdown</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shut down the EET library. <a href="#gacbc7583179399d3b3e7b003e911f866f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Eet__Group.html#ga5b3f70f4842551426befbff648e4094b">eet_clearcache</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear eet cache. <a href="#ga5b3f70f4842551426befbff648e4094b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions that affect Eet as a whole. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gaa9142d865094701672375485d4a6284d"></a><!-- doxytag: member="Eet.h::_Eet_Error" ref="gaa9142d865094701672375485d4a6284d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Eet__Group.html#gaa9142d865094701672375485d4a6284d">_Eet_Error</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>All the error identifiers known by Eet. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da2e3af24c66d0decf7c97fe4e5a7f75d4"></a><!-- doxytag: member="EET_ERROR_NONE" ref="ggaa9142d865094701672375485d4a6284da2e3af24c66d0decf7c97fe4e5a7f75d4" args="" -->EET_ERROR_NONE</em> </td><td>
<p>No error, it's all fine! </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da624f64fe9803c1a4229a60214d675fa4"></a><!-- doxytag: member="EET_ERROR_BAD_OBJECT" ref="ggaa9142d865094701672375485d4a6284da624f64fe9803c1a4229a60214d675fa4" args="" -->EET_ERROR_BAD_OBJECT</em> </td><td>
<p>Given object or handle is NULL or invalid. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da5d7b9168309be93bb29f1b031bad2677"></a><!-- doxytag: member="EET_ERROR_EMPTY" ref="ggaa9142d865094701672375485d4a6284da5d7b9168309be93bb29f1b031bad2677" args="" -->EET_ERROR_EMPTY</em> </td><td>
<p>There was nothing to do. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da0cf54c8e55c541d80273ba9297756217"></a><!-- doxytag: member="EET_ERROR_NOT_WRITABLE" ref="ggaa9142d865094701672375485d4a6284da0cf54c8e55c541d80273ba9297756217" args="" -->EET_ERROR_NOT_WRITABLE</em> </td><td>
<p>Could not write to file or fine is <a class="el" href="group__Eet__File__Group.html#ggaa8e1a7af50fefaf15eb2f69543d24998a416f7e9a76b8131a44bbeedb13060c81" title="File is read-only.">EET_FILE_MODE_READ</a>. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284daeffb124373b5049b86ac7e0dbefe53a3"></a><!-- doxytag: member="EET_ERROR_OUT_OF_MEMORY" ref="ggaa9142d865094701672375485d4a6284daeffb124373b5049b86ac7e0dbefe53a3" args="" -->EET_ERROR_OUT_OF_MEMORY</em> </td><td>
<p>Could not allocate memory. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da27684bc75504112ec1d973dd92b4bc54"></a><!-- doxytag: member="EET_ERROR_WRITE_ERROR" ref="ggaa9142d865094701672375485d4a6284da27684bc75504112ec1d973dd92b4bc54" args="" -->EET_ERROR_WRITE_ERROR</em> </td><td>
<p>Failed to write data to destination. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284dad809f5520943b5ddc7a5c2b13d011022"></a><!-- doxytag: member="EET_ERROR_WRITE_ERROR_FILE_TOO_BIG" ref="ggaa9142d865094701672375485d4a6284dad809f5520943b5ddc7a5c2b13d011022" args="" -->EET_ERROR_WRITE_ERROR_FILE_TOO_BIG</em> </td><td>
<p>Failed to write file since it is too big. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da161bbe3deff362f178e8cd5dd342f439"></a><!-- doxytag: member="EET_ERROR_WRITE_ERROR_IO_ERROR" ref="ggaa9142d865094701672375485d4a6284da161bbe3deff362f178e8cd5dd342f439" args="" -->EET_ERROR_WRITE_ERROR_IO_ERROR</em> </td><td>
<p>Failed to write since generic Input/Output error. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da8970e99b686ccb19cac6ce1b522bac46"></a><!-- doxytag: member="EET_ERROR_WRITE_ERROR_OUT_OF_SPACE" ref="ggaa9142d865094701672375485d4a6284da8970e99b686ccb19cac6ce1b522bac46" args="" -->EET_ERROR_WRITE_ERROR_OUT_OF_SPACE</em> </td><td>
<p>Failed to write due out of space. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da1f63beedf18d69778fe3d09756b0a127"></a><!-- doxytag: member="EET_ERROR_WRITE_ERROR_FILE_CLOSED" ref="ggaa9142d865094701672375485d4a6284da1f63beedf18d69778fe3d09756b0a127" args="" -->EET_ERROR_WRITE_ERROR_FILE_CLOSED</em> </td><td>
<p>Failed to write because file was closed. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284daedc70fb84c7eba864adf892b61fa7eed"></a><!-- doxytag: member="EET_ERROR_MMAP_FAILED" ref="ggaa9142d865094701672375485d4a6284daedc70fb84c7eba864adf892b61fa7eed" args="" -->EET_ERROR_MMAP_FAILED</em> </td><td>
<p>Could not mmap file. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284daa618d0cf4e95824b9ade43d916cb2661"></a><!-- doxytag: member="EET_ERROR_X509_ENCODING_FAILED" ref="ggaa9142d865094701672375485d4a6284daa618d0cf4e95824b9ade43d916cb2661" args="" -->EET_ERROR_X509_ENCODING_FAILED</em> </td><td>
<p>Could not encode using X509. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da478a6d16452e68c82773dcce92d6374a"></a><!-- doxytag: member="EET_ERROR_SIGNATURE_FAILED" ref="ggaa9142d865094701672375485d4a6284da478a6d16452e68c82773dcce92d6374a" args="" -->EET_ERROR_SIGNATURE_FAILED</em> </td><td>
<p>Could not validate signature. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da43880471e169e222f29daf7e356dc0e0"></a><!-- doxytag: member="EET_ERROR_INVALID_SIGNATURE" ref="ggaa9142d865094701672375485d4a6284da43880471e169e222f29daf7e356dc0e0" args="" -->EET_ERROR_INVALID_SIGNATURE</em> </td><td>
<p>Signature is invalid. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da65f57e87a9554a94c02f0e3d7b82af03"></a><!-- doxytag: member="EET_ERROR_NOT_SIGNED" ref="ggaa9142d865094701672375485d4a6284da65f57e87a9554a94c02f0e3d7b82af03" args="" -->EET_ERROR_NOT_SIGNED</em> </td><td>
<p>File or contents are not signed. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284dab2949e6f94af134c3b1dce154fd15a7d"></a><!-- doxytag: member="EET_ERROR_NOT_IMPLEMENTED" ref="ggaa9142d865094701672375485d4a6284dab2949e6f94af134c3b1dce154fd15a7d" args="" -->EET_ERROR_NOT_IMPLEMENTED</em> </td><td>
<p>Function is not implemented. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da172326f9ccae8830ef27a1f18acc4f19"></a><!-- doxytag: member="EET_ERROR_PRNG_NOT_SEEDED" ref="ggaa9142d865094701672375485d4a6284da172326f9ccae8830ef27a1f18acc4f19" args="" -->EET_ERROR_PRNG_NOT_SEEDED</em> </td><td>
<p>Could not introduce random seed. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284da04db0378f23672eb778283e2bd0fbd5c"></a><!-- doxytag: member="EET_ERROR_ENCRYPT_FAILED" ref="ggaa9142d865094701672375485d4a6284da04db0378f23672eb778283e2bd0fbd5c" args="" -->EET_ERROR_ENCRYPT_FAILED</em> </td><td>
<p>Could not encrypt contents. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa9142d865094701672375485d4a6284dad8ea52dac8f5ea43593e530f608edc38"></a><!-- doxytag: member="EET_ERROR_DECRYPT_FAILED" ref="ggaa9142d865094701672375485d4a6284dad8ea52dac8f5ea43593e530f608edc38" args="" -->EET_ERROR_DECRYPT_FAILED</em> </td><td>
<p>Could not decrypt contents. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga5b3f70f4842551426befbff648e4094b"></a><!-- doxytag: member="Eet.h::eet_clearcache" ref="ga5b3f70f4842551426befbff648e4094b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void eet_clearcache </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear eet cache. </p>
<p>Eet didn't free items by default. If you are under memory presure, just call this function to recall all memory that are not yet referenced anymore. The cache take care of modification on disk.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.0.0 </dd></dl>
<p>Referenced by <a class="el" href="eet__lib_8c_source.html#l00704">eet_shutdown()</a>.</p>
</div>
</div>
<a class="anchor" id="ga9903687bfa20fe9a9e59d4c1d213e89a"></a><!-- doxytag: member="Eet.h::eet_init" ref="ga9903687bfa20fe9a9e59d4c1d213e89a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int eet_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize the EET library. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new init count.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a class="anchor" id="gacbc7583179399d3b3e7b003e911f866f"></a><!-- doxytag: member="Eet.h::eet_shutdown" ref="gacbc7583179399d3b3e7b003e911f866f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int eet_shutdown </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shut down the EET library. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new init count.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>1.0.0 </dd></dl>
<p>References <a class="el" href="eet__lib_8c_source.html#l00749">eet_clearcache()</a>.</p>
</div>
</div>
</div>
<div id="push"></div>
</div> <!-- #content -->
</div> <!-- .layout -->
</div> <!-- #container -->
<div id="footer">
<table><tr>
<td class="poweredby"><img src="doxygen.png"></td>
<td class="copyright">Copyright ©2010 Enlightenment</td>
<td class="generated">Docs generated Fri Jul 2 11:41:28 2010</td>
</tr></table>
</div>
</body>
</html>
