<!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: ssh::SshException Class 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="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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ssh</b></li><li class="navelem"><a class="el" href="classssh_1_1SshException.html">SshException</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ssh::SshException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Some people do not like C++ exceptions.
<a href="classssh_1_1SshException.html#details">More...</a></p>
<p><code>#include <<a class="el" href="libsshpp_8hpp_source.html">include/libssh/libsshpp.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3f736fef0b7dbf062d11f64aa41a61f4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1SshException.html#a3f736fef0b7dbf062d11f64aa41a61f4">getCode</a> ()</td></tr>
<tr class="memdesc:a3f736fef0b7dbf062d11f64aa41a61f4"><td class="mdescLeft"> </td><td class="mdescRight">returns the Error code <a href="#a3f736fef0b7dbf062d11f64aa41a61f4">More...</a><br/></td></tr>
<tr class="separator:a3f736fef0b7dbf062d11f64aa41a61f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a712f65602f9ae8bc6737ed4b1e4ee4cc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1SshException.html#a712f65602f9ae8bc6737ed4b1e4ee4cc">getError</a> ()</td></tr>
<tr class="memdesc:a712f65602f9ae8bc6737ed4b1e4ee4cc"><td class="mdescLeft"> </td><td class="mdescRight">returns the error message of the last exception <a href="#a712f65602f9ae8bc6737ed4b1e4ee4cc">More...</a><br/></td></tr>
<tr class="separator:a712f65602f9ae8bc6737ed4b1e4ee4cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Some people do not like C++ exceptions. </p>
<p>With this define, we give the choice to use or not exceptions. if defined, disable C++ exceptions for libssh c++ wrapperThis class describes a SSH Exception object. This object can be thrown by several SSH functions that interact with the network, and may fail because of socket, protocol or memory errors. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3f736fef0b7dbf062d11f64aa41a61f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::SshException::getCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the Error code </p>
<dl class="section return"><dt>Returns</dt><dd>SSH_FATAL Fatal error happened (not recoverable) </dd>
<dd>
SSH_REQUEST_DENIED Request was denied by remote host </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__error.html#ga036433b7bf3d4ca94206253f58d136f9" title="Retrieve the error code from the last error.">ssh_get_error_code</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a712f65602f9ae8bc6737ed4b1e4ee4cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ssh::SshException::getError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the error message of the last exception </p>
<dl class="section return"><dt>Returns</dt><dd>pointer to a c string containing the description of error </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__error.html#ga9241586665bf21f823806473fc386258" title="Retrieve the error text message from the last error.">ssh_get_error</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/libssh/<a class="el" href="libsshpp_8hpp_source.html">libsshpp.hpp</a></li>
</ul>
</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>
