| Dir : /proc/thread-self/root/usr/share/doc/libssh-devel/html/ |
| Server: Linux server2.noticiasdecolima.com 4.18.0-553.30.1.el8_10.x86_64 #1 SMP Tue Nov 26 02:30:26 EST 2024 x86_64 IP: 107.161.180.42 |
| Dir : //proc/thread-self/root/usr/share/doc/libssh-devel/html/group__libssh__error.html |
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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>libssh: The SSH error functions.</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" />
<script src="striped_bg.js"></script>
<link href="that_style.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">libssh
 <span id="projectnumber">0.9.6</span>
</div>
<div id="projectbrief">The SSH library</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The SSH error functions.<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga03ff45cb8af89234c4c83beb6e7a8eab"><td class="memItemLeft" align="right" valign="top"><a id="ga03ff45cb8af89234c4c83beb6e7a8eab"></a>
void </td><td class="memItemRight" valign="bottom"><b>_ssh_set_error</b> (void *error, int code, const char *function, const char *descr,...)</td></tr>
<tr class="separator:ga03ff45cb8af89234c4c83beb6e7a8eab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d1eb111a8215cc82a9ad8bc3885c7df"><td class="memItemLeft" align="right" valign="top"><a id="ga9d1eb111a8215cc82a9ad8bc3885c7df"></a>
void </td><td class="memItemRight" valign="bottom"><b>_ssh_set_error_oom</b> (void *error, const char *function)</td></tr>
<tr class="separator:ga9d1eb111a8215cc82a9ad8bc3885c7df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5db8187e6666f7b255b80197f53fd359"><td class="memItemLeft" align="right" valign="top"><a id="ga5db8187e6666f7b255b80197f53fd359"></a>
void </td><td class="memItemRight" valign="bottom"><b>_ssh_set_error_invalid</b> (void *error, const char *function)</td></tr>
<tr class="separator:ga5db8187e6666f7b255b80197f53fd359"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa4e94327a2833d9e0eba2480a4988f7"><td class="memItemLeft" align="right" valign="top"><a id="gafa4e94327a2833d9e0eba2480a4988f7"></a>
void </td><td class="memItemRight" valign="bottom"><b>ssh_reset_error</b> (void *error)</td></tr>
<tr class="separator:gafa4e94327a2833d9e0eba2480a4988f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9241586665bf21f823806473fc386258"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__error.html#ga9241586665bf21f823806473fc386258">ssh_get_error</a> (void *error)</td></tr>
<tr class="memdesc:ga9241586665bf21f823806473fc386258"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the error text message from the last error. <a href="#ga9241586665bf21f823806473fc386258">More...</a><br /></td></tr>
<tr class="separator:ga9241586665bf21f823806473fc386258"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga036433b7bf3d4ca94206253f58d136f9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__error.html#ga036433b7bf3d4ca94206253f58d136f9">ssh_get_error_code</a> (void *error)</td></tr>
<tr class="memdesc:ga036433b7bf3d4ca94206253f58d136f9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the error code from the last error. <a href="#ga036433b7bf3d4ca94206253f58d136f9">More...</a><br /></td></tr>
<tr class="separator:ga036433b7bf3d4ca94206253f58d136f9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for error handling. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9241586665bf21f823806473fc386258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9241586665bf21f823806473fc386258">◆ </a></span>ssh_get_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ssh_get_error </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the error text message from the last error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>An ssh_session or ssh_bind.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A static string describing the error. </dd></dl>
</div>
</div>
<a id="ga036433b7bf3d4ca94206253f58d136f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga036433b7bf3d4ca94206253f58d136f9">◆ </a></span>ssh_get_error_code()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_get_error_code </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the error code from the last error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>An ssh_session or ssh_bind.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_NO_ERROR No error occurred<br />
SSH_REQUEST_DENIED The last request was denied but situation is recoverable<br />
SSH_FATAL A fatal error occurred. This could be an unexpected disconnection<br />
Other error codes are internal but can be considered same than SSH_FATAL. </dd></dl>
</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>