blob: 455762ceb21d208cea9286484ed69b771dca5df6 [file] [log] [blame]
<!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.6"/>
<title>libguac: guacamole/error-types.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
&#160;<span id="projectnumber">0.9.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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="headertitle">
<div class="title">error-types.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="error-types_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>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2014 Glyptodon LLC</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * THE SOFTWARE.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef _GUAC_ERROR_TYPES_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _GUAC_ERROR_TYPES_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86"> 35</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3"> 40</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3">GUAC_STATUS_SUCCESS</a> = 0,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a"> 45</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a">GUAC_STATUS_NO_MEMORY</a>,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97"> 51</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97">GUAC_STATUS_NO_INPUT</a>,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884"> 57</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884">GUAC_STATUS_INPUT_TIMEOUT</a>,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7"> 63</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7">GUAC_STATUS_SEE_ERRNO</a>,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73"> 69</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73">GUAC_STATUS_OUTPUT_ERROR</a>,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5"> 75</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5">GUAC_STATUS_BAD_ARGUMENT</a>,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854"> 81</a></span>&#160; <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854">GUAC_STATUS_BAD_STATE</a></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;} <a class="code" href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor"></span></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86abab29ecdd4072426136965c73186d80a">GUAC_STATUS_NO_MEMORY</a></div><div class="ttdoc">Insufficient memory to complete the operation. </div><div class="ttdef"><b>Definition:</b> error-types.h:45</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86">guac_status</a></div><div class="ttdeci">guac_status</div><div class="ttdoc">Return codes shared by all Guacamole functions which can fail. </div><div class="ttdef"><b>Definition:</b> error-types.h:35</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86aac7865c71bd2a0c9cc32c5491ba1db73">GUAC_STATUS_OUTPUT_ERROR</a></div><div class="ttdoc">An error prevented the operation from writing to its associated output stream. </div><div class="ttdef"><b>Definition:</b> error-types.h:69</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86ad62597670f649b347200557b5592d854">GUAC_STATUS_BAD_STATE</a></div><div class="ttdoc">The state of the associated system prevents an operation from being performed which would otherwise b...</div><div class="ttdef"><b>Definition:</b> error-types.h:81</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86af34a2ad1cc0601d22889bb5cbce273b7">GUAC_STATUS_SEE_ERRNO</a></div><div class="ttdoc">An error occurred, and further information about the error is already stored in errno. </div><div class="ttdef"><b>Definition:</b> error-types.h:63</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a54cd4d720ab872b6c4c40062f416bf97">GUAC_STATUS_NO_INPUT</a></div><div class="ttdoc">The end of the input stream associated with the operation has been reached. </div><div class="ttdef"><b>Definition:</b> error-types.h:51</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a05aa91b6406b1d4258619b4b6a2d92b3">GUAC_STATUS_SUCCESS</a></div><div class="ttdoc">No errors occurred and the operation was successful. </div><div class="ttdef"><b>Definition:</b> error-types.h:40</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a392deb602dfe8b31bda88a316ffcade5">GUAC_STATUS_BAD_ARGUMENT</a></div><div class="ttdoc">The operation could not be performed because an invalid argument was given. </div><div class="ttdef"><b>Definition:</b> error-types.h:75</div></div>
<div class="ttc" id="error-types_8h_html_a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884"><div class="ttname"><a href="error-types_8h.html#a1f4f9a73ee399e5dff424376eb4f9c86a5fab6cfff41290828fe6640100b21884">GUAC_STATUS_INPUT_TIMEOUT</a></div><div class="ttdoc">A timeout occurred while reading from the input stream associated with the operation. </div><div class="ttdef"><b>Definition:</b> error-types.h:57</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 30 2014 00:05:02 for libguac by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</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>