<html> <head> <title>Embryo: Error 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"> Embryo Documentation <small>at Tue Feb 8 2011</small> </div> <div class="menu-container"> <div class="submenu"> <ul class="current"> <li><a href="todo.html">Todo</a></li> <li><a href="files.html">Files</a></li> <li><a href="annotated.html">Data Structures</a></li> <li><a href="globals.html">Globals</a></li> <li><a href="modules.html">Modules</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.7.3 --> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>Error Functions</h1> </div> </div> <div class="contents"> <p>Functions that set and retrieve error codes in Embryo programs. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Error__Group.html#gaa761c3299a97a88043b36749a0e96a1d">embryo_program_error_set</a> (Embryo_Program *ep, Embryo_Error error)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the error code for the given program to the given code. <a href="#gaa761c3299a97a88043b36749a0e96a1d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">EAPI Embryo_Error </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Error__Group.html#ga104b8d8360cafb5bc0d1f4c759a2f365">embryo_program_error_get</a> (Embryo_Program *ep)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current error code for the given program. <a href="#ga104b8d8360cafb5bc0d1f4c759a2f365"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">EAPI const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Embryo__Error__Group.html#ga56f2294f676741f2b3689561a1733f59">embryo_error_string_get</a> (Embryo_Error error)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a string describing the given error code. <a href="#ga56f2294f676741f2b3689561a1733f59"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Functions that set and retrieve error codes in Embryo programs. </p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga56f2294f676741f2b3689561a1733f59"></a><!-- doxytag: member="embryo_amx.c::embryo_error_string_get" ref="ga56f2294f676741f2b3689561a1733f59" args="(Embryo_Error error)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EAPI const char* embryo_error_string_get </td> <td>(</td> <td class="paramtype">Embryo_Error </td> <td class="paramname"><em>error</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Retrieves a string describing the given error code. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The given error code. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>String describing the given error code. If the given code is not known, the string "(unknown)" is returned. </dd></dl> </div> </div> <a class="anchor" id="ga104b8d8360cafb5bc0d1f4c759a2f365"></a><!-- doxytag: member="embryo_amx.c::embryo_program_error_get" ref="ga104b8d8360cafb5bc0d1f4c759a2f365" args="(Embryo_Program *ep)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EAPI Embryo_Error embryo_program_error_get </td> <td>(</td> <td class="paramtype">Embryo_Program * </td> <td class="paramname"><em>ep</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Retrieves the current error code for the given program. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ep</td><td>The given program. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The current error code. </dd></dl> </div> </div> <a class="anchor" id="gaa761c3299a97a88043b36749a0e96a1d"></a><!-- doxytag: member="embryo_amx.c::embryo_program_error_set" ref="gaa761c3299a97a88043b36749a0e96a1d" args="(Embryo_Program *ep, Embryo_Error error)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EAPI void embryo_program_error_set </td> <td>(</td> <td class="paramtype">Embryo_Program * </td> <td class="paramname"><em>ep</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Embryo_Error </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the error code for the given program to the given code. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ep</td><td>The given program. </td></tr> <tr><td class="paramname">error</td><td>The given error code. </td></tr> </table> </dd> </dl> </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 ©2011 Enlightenment</td> <td class="generated">Docs generated Tue Feb 8 2011 18:11:42</td> </tr></table> </div> </body> </html>