<!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>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="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">libssh
 <span id="projectnumber">0.5.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<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">
<p>Functions for error handling.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></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 class="anchor" id="ga9241586665bf21f823806473fc386258"></a>
<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>The SSH session pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A static string describing the error. </dd></dl>
<p>Referenced by <a class="el" href="group__libssh__scp.html#ga2ca698c1e49612c083d9f8a72df52188">ssh_scp_leave_directory()</a>, <a class="el" href="group__libssh__scp.html#gaa584f03d4e3d582ac10a3a19818ec56d">ssh_scp_push_directory()</a>, <a class="el" href="group__libssh__scp.html#ga544f4b9c525071910110ada94148adc6">ssh_scp_push_file()</a>, and <a class="el" href="group__libssh__auth.html#gabe2888b00515e95f2e1dc50269f62027">ssh_try_publickey_from_file()</a>.</p>
</div>
</div>
<a class="anchor" id="ga036433b7bf3d4ca94206253f58d136f9"></a>
<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>The SSH session pointer.</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/>
</dd></dl>
<p>Other error codes are internal but can be considered same than SSH_FATAL. </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.3.1
</small></address>
</body>
</html>
