<!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.3.1"/> <title>libguac: error.h Source File</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.7.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <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> </div><!-- top --> <!-- 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 class="header"> <div class="headertitle"> <div class="title">error.h</div> </div> </div><!--header--> <div class="contents"> <a href="error_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* ***** BEGIN LICENSE BLOCK *****</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Version: MPL 1.1/GPL 2.0/LGPL 2.1</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The contents of this file are subject to the Mozilla Public License Version</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * 1.1 (the "License"); you may not use this file except in compliance with</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.mozilla.org/MPL/</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Software distributed under the License is distributed on an "AS IS" basis,</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * for the specific language governing rights and limitations under the</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * License.</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * The Original Code is libguac.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * The Initial Developer of the Original Code is</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Michael Jumper.</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Portions created by the Initial Developer are Copyright (C) 2010</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * the Initial Developer. All Rights Reserved.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Contributor(s):</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Alternatively, the contents of this file may be used under the terms of</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * either the GNU General Public License Version 2 or later (the "GPL"), or</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * in which case the provisions of the GPL or the LGPL are applicable instead</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * of those above. If you wish to allow use of your version of this file only</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * under the terms of either the GPL or the LGPL, and not to allow others to</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * use your version of this file under the terms of the MPL, indicate your</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * decision by deleting the provisions above and replace them with the notice</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * and other provisions required by the GPL or the LGPL. If you do not delete</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * the provisions above, a recipient may use your version of this file under</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * the terms of any one of the MPL, the GPL or the LGPL.</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * ***** END LICENSE BLOCK ***** */</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef _GUAC_ERROR_H</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define _GUAC_ERROR_H</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86"> 52</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86" title="Return codes shared by all Guacamole functions which can fail.">guac_status</a> {</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> <div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3"> 57</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3" title="No errors occurred and the operation was successful.">GUAC_STATUS_SUCCESS</a> = 0,</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a"> 62</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a" title="Insufficient memory to complete the operation.">GUAC_STATUS_NO_MEMORY</a>,</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97"> 68</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97" title="The end of the input stream associated with the operation has been reached.">GUAC_STATUS_NO_INPUT</a>,</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884"> 74</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884" title="A timeout occurred while reading from the input stream associated with the operation.">GUAC_STATUS_INPUT_TIMEOUT</a>,</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7"> 80</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7" title="An error occurred, and further information about the error is already stored in errno.">GUAC_STATUS_SEE_ERRNO</a>,</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73"> 86</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73" title="An error prevented the operation from writing to its associated output stream.">GUAC_STATUS_OUTPUT_ERROR</a>,</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5"> 92</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5" title="The operation could not be performed because an invalid argument was given.">GUAC_STATUS_BAD_ARGUMENT</a>,</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div> <div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854"> 98</a></span>  <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854" title="The state of the associated system prevents an operation from being performed which would otherwise b...">GUAC_STATUS_BAD_STATE</a></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86" title="Return codes shared by all Guacamole functions which can fail.">guac_status</a>;</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="error_8h.html#a485ffed08fa59ca7366f71c1ccb14f6e" title="Returns a human-readable explanation of the status code given.">guac_status_string</a>(<a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86" title="Return codes shared by all Guacamole functions which can fail.">guac_status</a> status);</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div> <div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="error_8h.html#a44aa5f7b9e896438fcdf16fe7feefd07"> 115</a></span> <span class="preprocessor">#define guac_error (*__guac_error())</span></div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <a class="code" href="error_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86" title="Return codes shared by all Guacamole functions which can fail.">guac_status</a>* __guac_error();</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> <div class="line"><a name="l00128"></a><span class="lineno"><a class="code" href="error_8h.html#a96ab3903ba0e97c745e8bfb006e123cd"> 128</a></span> <span class="preprocessor">#define guac_error_message (*__guac_error_message())</span></div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">const</span> <span class="keywordtype">char</span>** __guac_error_message();</div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Jun 19 2013 12:42:07 for libguac by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>