| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <title>libguac: guacamole/error.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">libguac |
|  <span id="projectnumber">0.8.4</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.1.2 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>Globals</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">error.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Provides functions and structures required for handling return values and errors. |
| <a href="#details">More...</a></p> |
| |
| <p><a href="error_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:a44aa5f7b9e896438fcdf16fe7feefd07"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a44aa5f7b9e896438fcdf16fe7feefd07">guac_error</a>   (*__guac_error())</td></tr> |
| <tr class="memdesc:a44aa5f7b9e896438fcdf16fe7feefd07"><td class="mdescLeft"> </td><td class="mdescRight">Returns the status code associated with the error which occurred during the last function call. <a href="#a44aa5f7b9e896438fcdf16fe7feefd07"></a><br/></td></tr> |
| <tr class="memitem:a96ab3903ba0e97c745e8bfb006e123cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a96ab3903ba0e97c745e8bfb006e123cd">guac_error_message</a>   (*__guac_error_message())</td></tr> |
| <tr class="memdesc:a96ab3903ba0e97c745e8bfb006e123cd"><td class="mdescLeft"> </td><td class="mdescRight">Returns a message describing the error which occurred during the last function call. <a href="#a96ab3903ba0e97c745e8bfb006e123cd"></a><br/></td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:a1f4f9a73ee399e5dff424376eb4f9c86"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a> { <br/> |
|   <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3">GUAC_STATUS_SUCCESS</a> = 0, |
| <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a">GUAC_STATUS_NO_MEMORY</a>, |
| <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97">GUAC_STATUS_NO_INPUT</a>, |
| <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884">GUAC_STATUS_INPUT_TIMEOUT</a>, |
| <br/> |
|   <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7">GUAC_STATUS_SEE_ERRNO</a>, |
| <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73">GUAC_STATUS_OUTPUT_ERROR</a>, |
| <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5">GUAC_STATUS_BAD_ARGUMENT</a>, |
| <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854">GUAC_STATUS_BAD_STATE</a> |
| <br/> |
| }</td></tr> |
| <tr class="memdesc:a1f4f9a73ee399e5dff424376eb4f9c86"><td class="mdescLeft"> </td><td class="mdescRight">Return codes shared by all Guacamole functions which can fail. <a href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">More...</a><br/></td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a485ffed08fa59ca7366f71c1ccb14f6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a485ffed08fa59ca7366f71c1ccb14f6e"></a> |
| const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a485ffed08fa59ca7366f71c1ccb14f6e">guac_status_string</a> (<a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a> status)</td></tr> |
| <tr class="memdesc:a485ffed08fa59ca7366f71c1ccb14f6e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a human-readable explanation of the status code given. <br/></td></tr> |
| </table> |
| <a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><p>Provides functions and structures required for handling return values and errors. </p> |
| </div><h2>Macro Definition Documentation</h2> |
| <a class="anchor" id="a44aa5f7b9e896438fcdf16fe7feefd07"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define guac_error   (*__guac_error())</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the status code associated with the error which occurred during the last function call. </p> |
| <p>This value will only be set by functions documented to use it (most libguac functions), and is undefined if no error occurred.</p> |
| <p>The storage of this value is thread-local. Assignment of a status code to guac_error in one thread will not affect its value in another thread. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a96ab3903ba0e97c745e8bfb006e123cd"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define guac_error_message   (*__guac_error_message())</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a message describing the error which occurred during the last function call. </p> |
| <p>If an error occurred, but no message is associated with it, NULL is returned. This value is undefined if no error occurred.</p> |
| <p>The storage of this value is thread-local. Assignment of a message to guac_error_message in one thread will not affect its value in another thread. </p> |
| |
| </div> |
| </div> |
| <h2>Enumeration Type Documentation</h2> |
| <a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return codes shared by all Guacamole functions which can fail. </p> |
| <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3"></a>GUAC_STATUS_SUCCESS</em> </td><td> |
| <p>No errors occurred and the operation was successful. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a"></a>GUAC_STATUS_NO_MEMORY</em> </td><td> |
| <p>Insufficient memory to complete the operation. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97"></a>GUAC_STATUS_NO_INPUT</em> </td><td> |
| <p>The end of the input stream associated with the operation has been reached. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884"></a>GUAC_STATUS_INPUT_TIMEOUT</em> </td><td> |
| <p>A timeout occurred while reading from the input stream associated with the operation. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7"></a>GUAC_STATUS_SEE_ERRNO</em> </td><td> |
| <p>An error occurred, and further information about the error is already stored in errno. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73"></a>GUAC_STATUS_OUTPUT_ERROR</em> </td><td> |
| <p>An error prevented the operation from writing to its associated output stream. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5"></a>GUAC_STATUS_BAD_ARGUMENT</em> </td><td> |
| <p>The operation could not be performed because an invalid argument was given. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854"></a>GUAC_STATUS_BAD_STATE</em> </td><td> |
| <p>The state of the associated system prevents an operation from being performed which would otherwise be allowed. </p> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Fri May 23 2014 12:01:41 for libguac by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.1.2 |
| </small></address> |
| |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-75289145-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script> |
| <!-- End Google Analytics --> |
| </body> |
| </html> |
