| <!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"/> |
| <meta name="generator" content="Doxygen 1.8.14"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <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/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">libguac |
|  <span id="projectnumber">1.1.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.14 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </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="#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 class="groupheader"><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">More...</a><br /></td></tr> |
| <tr class="separator:a44aa5f7b9e896438fcdf16fe7feefd07"><td class="memSeparator" colspan="2"> </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">More...</a><br /></td></tr> |
| <tr class="separator:a96ab3903ba0e97c745e8bfb006e123cd"><td class="memSeparator" colspan="2"> </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">More...</a><br /></td></tr> |
| <tr class="separator:a44aa5f7b9e896438fcdf16fe7feefd07"><td class="memSeparator" colspan="2"> </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">More...</a><br /></td></tr> |
| <tr class="separator:a96ab3903ba0e97c745e8bfb006e123cd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a39a2290527ea7c3f0acb07f002c397b1"><td class="memItemLeft" align="right" valign="top"><a id="a39a2290527ea7c3f0acb07f002c397b1"></a> |
| const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a39a2290527ea7c3f0acb07f002c397b1">guac_status_string</a> (<a class="el" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a> status)</td></tr> |
| <tr class="memdesc:a39a2290527ea7c3f0acb07f002c397b1"><td class="mdescLeft"> </td><td class="mdescRight">Returns a human-readable explanation of the status code given. <br /></td></tr> |
| <tr class="separator:a39a2290527ea7c3f0acb07f002c397b1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Provides functions and structures required for handling return values and errors. </p> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="a44aa5f7b9e896438fcdf16fe7feefd07"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a44aa5f7b9e896438fcdf16fe7feefd07">◆ </a></span>guac_error <span class="overload">[1/2]</span></h2> |
| |
| <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 id="a44aa5f7b9e896438fcdf16fe7feefd07"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a44aa5f7b9e896438fcdf16fe7feefd07">◆ </a></span>guac_error <span class="overload">[2/2]</span></h2> |
| |
| <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 id="a96ab3903ba0e97c745e8bfb006e123cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96ab3903ba0e97c745e8bfb006e123cd">◆ </a></span>guac_error_message <span class="overload">[1/2]</span></h2> |
| |
| <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> |
| <a id="a96ab3903ba0e97c745e8bfb006e123cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96ab3903ba0e97c745e8bfb006e123cd">◆ </a></span>guac_error_message <span class="overload">[2/2]</span></h2> |
| |
| <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> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.14 |
| </small></address> |
| </body> |
| </html> |