<!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: include/libssh/sftp.h File 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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b9682cd10a3f48e47321de8901f87a77.html">libssh</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">sftp.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SFTP handling functions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <sys/types.h></code><br/>
<code>#include "libssh.h"</code><br/>
</div>
<p><a href="sftp_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Server responses</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Responses returned by the sftp server. </p>
</div></td></tr>
<tr class="memitem:ga8db0fdad334ce6e77c7a698947c2f118"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8db0fdad334ce6e77c7a698947c2f118"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga8db0fdad334ce6e77c7a698947c2f118">SSH_FX_OK</a>   0</td></tr>
<tr class="memdesc:ga8db0fdad334ce6e77c7a698947c2f118"><td class="mdescLeft"> </td><td class="mdescRight">No error. <br/></td></tr>
<tr class="separator:ga8db0fdad334ce6e77c7a698947c2f118"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9e0923585f3a60c782d483863799f01f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e0923585f3a60c782d483863799f01f"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga9e0923585f3a60c782d483863799f01f">SSH_FX_EOF</a>   1</td></tr>
<tr class="memdesc:ga9e0923585f3a60c782d483863799f01f"><td class="mdescLeft"> </td><td class="mdescRight">End-of-file encountered. <br/></td></tr>
<tr class="separator:ga9e0923585f3a60c782d483863799f01f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9bcfb9bfc410f1493424c4492fea8016"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9bcfb9bfc410f1493424c4492fea8016"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga9bcfb9bfc410f1493424c4492fea8016">SSH_FX_NO_SUCH_FILE</a>   2</td></tr>
<tr class="memdesc:ga9bcfb9bfc410f1493424c4492fea8016"><td class="mdescLeft"> </td><td class="mdescRight">File doesn't exist. <br/></td></tr>
<tr class="separator:ga9bcfb9bfc410f1493424c4492fea8016"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75c7f502ec17cd22a5777997e0776694"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga75c7f502ec17cd22a5777997e0776694"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga75c7f502ec17cd22a5777997e0776694">SSH_FX_PERMISSION_DENIED</a>   3</td></tr>
<tr class="memdesc:ga75c7f502ec17cd22a5777997e0776694"><td class="mdescLeft"> </td><td class="mdescRight">Permission denied. <br/></td></tr>
<tr class="separator:ga75c7f502ec17cd22a5777997e0776694"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad01f42405d742709739ad708277004c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad01f42405d742709739ad708277004c3"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gad01f42405d742709739ad708277004c3">SSH_FX_FAILURE</a>   4</td></tr>
<tr class="memdesc:gad01f42405d742709739ad708277004c3"><td class="mdescLeft"> </td><td class="mdescRight">Generic failure. <br/></td></tr>
<tr class="separator:gad01f42405d742709739ad708277004c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12cb3bf50e715473c2ca5ccb69965cf3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga12cb3bf50e715473c2ca5ccb69965cf3"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga12cb3bf50e715473c2ca5ccb69965cf3">SSH_FX_BAD_MESSAGE</a>   5</td></tr>
<tr class="memdesc:ga12cb3bf50e715473c2ca5ccb69965cf3"><td class="mdescLeft"> </td><td class="mdescRight">Garbage received from server. <br/></td></tr>
<tr class="separator:ga12cb3bf50e715473c2ca5ccb69965cf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3da0fc47440139efceb8a9220e31875c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3da0fc47440139efceb8a9220e31875c"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga3da0fc47440139efceb8a9220e31875c">SSH_FX_NO_CONNECTION</a>   6</td></tr>
<tr class="memdesc:ga3da0fc47440139efceb8a9220e31875c"><td class="mdescLeft"> </td><td class="mdescRight">No connection has been set up. <br/></td></tr>
<tr class="separator:ga3da0fc47440139efceb8a9220e31875c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga721ad225dfe6638384e388c5fe1cb42b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga721ad225dfe6638384e388c5fe1cb42b"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga721ad225dfe6638384e388c5fe1cb42b">SSH_FX_CONNECTION_LOST</a>   7</td></tr>
<tr class="memdesc:ga721ad225dfe6638384e388c5fe1cb42b"><td class="mdescLeft"> </td><td class="mdescRight">There was a connection, but we lost it. <br/></td></tr>
<tr class="separator:ga721ad225dfe6638384e388c5fe1cb42b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga383f2d50fd2cae076c270f84ffe6c044"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga383f2d50fd2cae076c270f84ffe6c044"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga383f2d50fd2cae076c270f84ffe6c044">SSH_FX_OP_UNSUPPORTED</a>   8</td></tr>
<tr class="memdesc:ga383f2d50fd2cae076c270f84ffe6c044"><td class="mdescLeft"> </td><td class="mdescRight">Operation not supported by the server. <br/></td></tr>
<tr class="separator:ga383f2d50fd2cae076c270f84ffe6c044"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb2010df724d8c8d0b5414a63b7ac859"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadb2010df724d8c8d0b5414a63b7ac859"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gadb2010df724d8c8d0b5414a63b7ac859">SSH_FX_INVALID_HANDLE</a>   9</td></tr>
<tr class="memdesc:gadb2010df724d8c8d0b5414a63b7ac859"><td class="mdescLeft"> </td><td class="mdescRight">Invalid file handle. <br/></td></tr>
<tr class="separator:gadb2010df724d8c8d0b5414a63b7ac859"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga473dd6f7267ff262441e8a2aab3c33c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga473dd6f7267ff262441e8a2aab3c33c8"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga473dd6f7267ff262441e8a2aab3c33c8">SSH_FX_NO_SUCH_PATH</a>   10</td></tr>
<tr class="memdesc:ga473dd6f7267ff262441e8a2aab3c33c8"><td class="mdescLeft"> </td><td class="mdescRight">No such file or directory path exists. <br/></td></tr>
<tr class="separator:ga473dd6f7267ff262441e8a2aab3c33c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabae8a18fd96320cc78ea052eb269ed38"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabae8a18fd96320cc78ea052eb269ed38"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gabae8a18fd96320cc78ea052eb269ed38">SSH_FX_FILE_ALREADY_EXISTS</a>   11</td></tr>
<tr class="memdesc:gabae8a18fd96320cc78ea052eb269ed38"><td class="mdescLeft"> </td><td class="mdescRight">An attempt to create an already existing file or directory has been made. <br/></td></tr>
<tr class="separator:gabae8a18fd96320cc78ea052eb269ed38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e734958d6410066f1b1adf503ce52d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0e734958d6410066f1b1adf503ce52d8"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga0e734958d6410066f1b1adf503ce52d8">SSH_FX_WRITE_PROTECT</a>   12</td></tr>
<tr class="memdesc:ga0e734958d6410066f1b1adf503ce52d8"><td class="mdescLeft"> </td><td class="mdescRight">We are trying to write on a write-protected filesystem. <br/></td></tr>
<tr class="separator:ga0e734958d6410066f1b1adf503ce52d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e7ba323d3bd55c416d9b4529f8e8d82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8e7ba323d3bd55c416d9b4529f8e8d82"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga8e7ba323d3bd55c416d9b4529f8e8d82">SSH_FX_NO_MEDIA</a>   13</td></tr>
<tr class="memdesc:ga8e7ba323d3bd55c416d9b4529f8e8d82"><td class="mdescLeft"> </td><td class="mdescRight">No media in remote drive. <br/></td></tr>
<tr class="separator:ga8e7ba323d3bd55c416d9b4529f8e8d82"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4399c7ccd8b39a460265047f9d7bc9b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga4399c7ccd8b39a460265047f9d7bc9b1">sftp_async_read</a> (sftp_file file, void *data, uint32_t len, uint32_t id)</td></tr>
<tr class="memdesc:ga4399c7ccd8b39a460265047f9d7bc9b1"><td class="mdescLeft"> </td><td class="mdescRight">Wait for an asynchronous read to complete and save the data. <a href="group__libssh__sftp.html#ga4399c7ccd8b39a460265047f9d7bc9b1">More...</a><br/></td></tr>
<tr class="separator:ga4399c7ccd8b39a460265047f9d7bc9b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c2cca19b38c54d4b04bb3584b0517cd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga4c2cca19b38c54d4b04bb3584b0517cd">sftp_async_read_begin</a> (sftp_file file, uint32_t len)</td></tr>
<tr class="memdesc:ga4c2cca19b38c54d4b04bb3584b0517cd"><td class="mdescLeft"> </td><td class="mdescRight">Start an asynchronous read from a file using an opened sftp file handle. <a href="group__libssh__sftp.html#ga4c2cca19b38c54d4b04bb3584b0517cd">More...</a><br/></td></tr>
<tr class="separator:ga4c2cca19b38c54d4b04bb3584b0517cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadee9f7af9fc1ad3a0a66c7d97bf7977c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gadee9f7af9fc1ad3a0a66c7d97bf7977c">sftp_attributes_free</a> (sftp_attributes file)</td></tr>
<tr class="memdesc:gadee9f7af9fc1ad3a0a66c7d97bf7977c"><td class="mdescLeft"> </td><td class="mdescRight">Free a sftp attribute structure. <a href="group__libssh__sftp.html#gadee9f7af9fc1ad3a0a66c7d97bf7977c">More...</a><br/></td></tr>
<tr class="separator:gadee9f7af9fc1ad3a0a66c7d97bf7977c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga69b4d6f723565e3fcac2b37159262af5"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga69b4d6f723565e3fcac2b37159262af5">sftp_canonicalize_path</a> (sftp_session sftp, const char *path)</td></tr>
<tr class="memdesc:ga69b4d6f723565e3fcac2b37159262af5"><td class="mdescLeft"> </td><td class="mdescRight">Canonicalize a sftp path. <a href="group__libssh__sftp.html#ga69b4d6f723565e3fcac2b37159262af5">More...</a><br/></td></tr>
<tr class="separator:ga69b4d6f723565e3fcac2b37159262af5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga311a4bc202d406c916c8b9ad5fe79ac7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga311a4bc202d406c916c8b9ad5fe79ac7">sftp_chmod</a> (sftp_session sftp, const char *file, mode_t mode)</td></tr>
<tr class="memdesc:ga311a4bc202d406c916c8b9ad5fe79ac7"><td class="mdescLeft"> </td><td class="mdescRight">Change permissions of a file. <a href="group__libssh__sftp.html#ga311a4bc202d406c916c8b9ad5fe79ac7">More...</a><br/></td></tr>
<tr class="separator:ga311a4bc202d406c916c8b9ad5fe79ac7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga18abafba9db590408ee2301a27698f2c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga18abafba9db590408ee2301a27698f2c">sftp_chown</a> (sftp_session sftp, const char *file, uid_t owner, gid_t group)</td></tr>
<tr class="memdesc:ga18abafba9db590408ee2301a27698f2c"><td class="mdescLeft"> </td><td class="mdescRight">Change the file owner and group. <a href="group__libssh__sftp.html#ga18abafba9db590408ee2301a27698f2c">More...</a><br/></td></tr>
<tr class="separator:ga18abafba9db590408ee2301a27698f2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5878919249d4e8abe59b0ec699eed293"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga5878919249d4e8abe59b0ec699eed293">sftp_close</a> (sftp_file file)</td></tr>
<tr class="memdesc:ga5878919249d4e8abe59b0ec699eed293"><td class="mdescLeft"> </td><td class="mdescRight">Close an open file handle. <a href="group__libssh__sftp.html#ga5878919249d4e8abe59b0ec699eed293">More...</a><br/></td></tr>
<tr class="separator:ga5878919249d4e8abe59b0ec699eed293"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35551e5b28b192ef8035628d347f7d3e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga35551e5b28b192ef8035628d347f7d3e">sftp_closedir</a> (sftp_dir dir)</td></tr>
<tr class="memdesc:ga35551e5b28b192ef8035628d347f7d3e"><td class="mdescLeft"> </td><td class="mdescRight">Close a directory handle opened by <a class="el" href="group__libssh__sftp.html#gab4290874bdb55796b2823496e0d9b7ec" title="Open a directory used to obtain directory entries.">sftp_opendir()</a>. <a href="group__libssh__sftp.html#ga35551e5b28b192ef8035628d347f7d3e">More...</a><br/></td></tr>
<tr class="separator:ga35551e5b28b192ef8035628d347f7d3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad60f8e71b06eb8fdae2b262bb58f8fec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gad60f8e71b06eb8fdae2b262bb58f8fec">sftp_dir_eof</a> (sftp_dir dir)</td></tr>
<tr class="memdesc:gad60f8e71b06eb8fdae2b262bb58f8fec"><td class="mdescLeft"> </td><td class="mdescRight">Tell if the directory has reached EOF (End Of File). <a href="group__libssh__sftp.html#gad60f8e71b06eb8fdae2b262bb58f8fec">More...</a><br/></td></tr>
<tr class="separator:gad60f8e71b06eb8fdae2b262bb58f8fec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga190d0bb19ed8e571ab884d28ee82adfe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga190d0bb19ed8e571ab884d28ee82adfe">sftp_extension_supported</a> (sftp_session sftp, const char *name, const char *data)</td></tr>
<tr class="memdesc:ga190d0bb19ed8e571ab884d28ee82adfe"><td class="mdescLeft"> </td><td class="mdescRight">Check if the given extension is supported. <a href="group__libssh__sftp.html#ga190d0bb19ed8e571ab884d28ee82adfe">More...</a><br/></td></tr>
<tr class="separator:ga190d0bb19ed8e571ab884d28ee82adfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga300723724353ccc490b9c0c55bbee668"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga300723724353ccc490b9c0c55bbee668">sftp_extensions_get_count</a> (sftp_session sftp)</td></tr>
<tr class="memdesc:ga300723724353ccc490b9c0c55bbee668"><td class="mdescLeft"> </td><td class="mdescRight">Get the count of extensions provided by the server. <a href="group__libssh__sftp.html#ga300723724353ccc490b9c0c55bbee668">More...</a><br/></td></tr>
<tr class="separator:ga300723724353ccc490b9c0c55bbee668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad7391f28160aaa883429a3b0aa87e339"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gad7391f28160aaa883429a3b0aa87e339">sftp_extensions_get_data</a> (sftp_session sftp, unsigned int indexn)</td></tr>
<tr class="memdesc:gad7391f28160aaa883429a3b0aa87e339"><td class="mdescLeft"> </td><td class="mdescRight">Get the data of the extension provided by the server. <a href="group__libssh__sftp.html#gad7391f28160aaa883429a3b0aa87e339">More...</a><br/></td></tr>
<tr class="separator:gad7391f28160aaa883429a3b0aa87e339"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bcf9a99f395c86c5f99b9a8009e9533"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga8bcf9a99f395c86c5f99b9a8009e9533">sftp_extensions_get_name</a> (sftp_session sftp, unsigned int indexn)</td></tr>
<tr class="memdesc:ga8bcf9a99f395c86c5f99b9a8009e9533"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the extension provided by the server. <a href="group__libssh__sftp.html#ga8bcf9a99f395c86c5f99b9a8009e9533">More...</a><br/></td></tr>
<tr class="separator:ga8bcf9a99f395c86c5f99b9a8009e9533"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga155c66639cb3342c7e02a96c8dbf7501"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga155c66639cb3342c7e02a96c8dbf7501">sftp_free</a> (sftp_session sftp)</td></tr>
<tr class="memdesc:ga155c66639cb3342c7e02a96c8dbf7501"><td class="mdescLeft"> </td><td class="mdescRight">Close and deallocate a sftp session. <a href="group__libssh__sftp.html#ga155c66639cb3342c7e02a96c8dbf7501">More...</a><br/></td></tr>
<tr class="separator:ga155c66639cb3342c7e02a96c8dbf7501"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad9cc3609096b1fffa99f59c852415668"><td class="memItemLeft" align="right" valign="top">sftp_attributes </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gad9cc3609096b1fffa99f59c852415668">sftp_fstat</a> (sftp_file file)</td></tr>
<tr class="memdesc:gad9cc3609096b1fffa99f59c852415668"><td class="mdescLeft"> </td><td class="mdescRight">Get information about a file or directory from a file handle. <a href="group__libssh__sftp.html#gad9cc3609096b1fffa99f59c852415668">More...</a><br/></td></tr>
<tr class="separator:gad9cc3609096b1fffa99f59c852415668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f14490f71825904232dc418b7843b9f"><td class="memItemLeft" align="right" valign="top">sftp_statvfs_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga6f14490f71825904232dc418b7843b9f">sftp_fstatvfs</a> (sftp_file file)</td></tr>
<tr class="memdesc:ga6f14490f71825904232dc418b7843b9f"><td class="mdescLeft"> </td><td class="mdescRight">Get information about a mounted file system. <a href="group__libssh__sftp.html#ga6f14490f71825904232dc418b7843b9f">More...</a><br/></td></tr>
<tr class="separator:ga6f14490f71825904232dc418b7843b9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f7fca4091a0075d9e69e47c928f7494"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga1f7fca4091a0075d9e69e47c928f7494">sftp_get_error</a> (sftp_session sftp)</td></tr>
<tr class="memdesc:ga1f7fca4091a0075d9e69e47c928f7494"><td class="mdescLeft"> </td><td class="mdescRight">Get the last sftp error. <a href="group__libssh__sftp.html#ga1f7fca4091a0075d9e69e47c928f7494">More...</a><br/></td></tr>
<tr class="separator:ga1f7fca4091a0075d9e69e47c928f7494"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6eb5a92e33493ec3d9a3576e1617da0d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga6eb5a92e33493ec3d9a3576e1617da0d">sftp_init</a> (sftp_session sftp)</td></tr>
<tr class="memdesc:ga6eb5a92e33493ec3d9a3576e1617da0d"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the sftp session with the server. <a href="group__libssh__sftp.html#ga6eb5a92e33493ec3d9a3576e1617da0d">More...</a><br/></td></tr>
<tr class="separator:ga6eb5a92e33493ec3d9a3576e1617da0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e4a3cd284ad72a1c5092c4cef72dfca"><td class="memItemLeft" align="right" valign="top">sftp_attributes </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga7e4a3cd284ad72a1c5092c4cef72dfca">sftp_lstat</a> (sftp_session session, const char *path)</td></tr>
<tr class="memdesc:ga7e4a3cd284ad72a1c5092c4cef72dfca"><td class="mdescLeft"> </td><td class="mdescRight">Get information about a file or directory. <a href="group__libssh__sftp.html#ga7e4a3cd284ad72a1c5092c4cef72dfca">More...</a><br/></td></tr>
<tr class="separator:ga7e4a3cd284ad72a1c5092c4cef72dfca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9cc63cd3efe83edfa3f6a4c5314383cb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga9cc63cd3efe83edfa3f6a4c5314383cb">sftp_mkdir</a> (sftp_session sftp, const char *directory, mode_t mode)</td></tr>
<tr class="memdesc:ga9cc63cd3efe83edfa3f6a4c5314383cb"><td class="mdescLeft"> </td><td class="mdescRight">Create a directory. <a href="group__libssh__sftp.html#ga9cc63cd3efe83edfa3f6a4c5314383cb">More...</a><br/></td></tr>
<tr class="separator:ga9cc63cd3efe83edfa3f6a4c5314383cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga32c8e182e97352e1aa8a20443c320d7f"><td class="memItemLeft" align="right" valign="top">sftp_session </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga32c8e182e97352e1aa8a20443c320d7f">sftp_new</a> (ssh_session session)</td></tr>
<tr class="memdesc:ga32c8e182e97352e1aa8a20443c320d7f"><td class="mdescLeft"> </td><td class="mdescRight">Start a new sftp session. <a href="group__libssh__sftp.html#ga32c8e182e97352e1aa8a20443c320d7f">More...</a><br/></td></tr>
<tr class="separator:ga32c8e182e97352e1aa8a20443c320d7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab95cb5fe091efcc49dfa7729e4d48010"><td class="memItemLeft" align="right" valign="top">sftp_file </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gab95cb5fe091efcc49dfa7729e4d48010">sftp_open</a> (sftp_session session, const char *file, int accesstype, mode_t mode)</td></tr>
<tr class="memdesc:gab95cb5fe091efcc49dfa7729e4d48010"><td class="mdescLeft"> </td><td class="mdescRight">Open a file on the server. <a href="group__libssh__sftp.html#gab95cb5fe091efcc49dfa7729e4d48010">More...</a><br/></td></tr>
<tr class="separator:gab95cb5fe091efcc49dfa7729e4d48010"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4290874bdb55796b2823496e0d9b7ec"><td class="memItemLeft" align="right" valign="top">sftp_dir </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gab4290874bdb55796b2823496e0d9b7ec">sftp_opendir</a> (sftp_session session, const char *path)</td></tr>
<tr class="memdesc:gab4290874bdb55796b2823496e0d9b7ec"><td class="mdescLeft"> </td><td class="mdescRight">Open a directory used to obtain directory entries. <a href="group__libssh__sftp.html#gab4290874bdb55796b2823496e0d9b7ec">More...</a><br/></td></tr>
<tr class="separator:gab4290874bdb55796b2823496e0d9b7ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6c2bfeb2e089f54c04afe1e484a7fff2"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga6c2bfeb2e089f54c04afe1e484a7fff2">sftp_read</a> (sftp_file file, void *buf, size_t count)</td></tr>
<tr class="memdesc:ga6c2bfeb2e089f54c04afe1e484a7fff2"><td class="mdescLeft"> </td><td class="mdescRight">Read from a file using an opened sftp file handle. <a href="group__libssh__sftp.html#ga6c2bfeb2e089f54c04afe1e484a7fff2">More...</a><br/></td></tr>
<tr class="separator:ga6c2bfeb2e089f54c04afe1e484a7fff2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga976ecf6f7d415856e1fd4a0f16ada9b8"><td class="memItemLeft" align="right" valign="top">sftp_attributes </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga976ecf6f7d415856e1fd4a0f16ada9b8">sftp_readdir</a> (sftp_session session, sftp_dir dir)</td></tr>
<tr class="memdesc:ga976ecf6f7d415856e1fd4a0f16ada9b8"><td class="mdescLeft"> </td><td class="mdescRight">Get a single file attributes structure of a directory. <a href="group__libssh__sftp.html#ga976ecf6f7d415856e1fd4a0f16ada9b8">More...</a><br/></td></tr>
<tr class="separator:ga976ecf6f7d415856e1fd4a0f16ada9b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ee06dcf214cb4b67195fa7f5ce5027c"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga1ee06dcf214cb4b67195fa7f5ce5027c">sftp_readlink</a> (sftp_session sftp, const char *path)</td></tr>
<tr class="memdesc:ga1ee06dcf214cb4b67195fa7f5ce5027c"><td class="mdescLeft"> </td><td class="mdescRight">Read the value of a symbolic link. <a href="group__libssh__sftp.html#ga1ee06dcf214cb4b67195fa7f5ce5027c">More...</a><br/></td></tr>
<tr class="separator:ga1ee06dcf214cb4b67195fa7f5ce5027c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1175bc5bde655df5dbd925bc98379aef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga1175bc5bde655df5dbd925bc98379aef">sftp_rename</a> (sftp_session sftp, const char *original, const char *newname)</td></tr>
<tr class="memdesc:ga1175bc5bde655df5dbd925bc98379aef"><td class="mdescLeft"> </td><td class="mdescRight">Rename or move a file or directory. <a href="group__libssh__sftp.html#ga1175bc5bde655df5dbd925bc98379aef">More...</a><br/></td></tr>
<tr class="separator:ga1175bc5bde655df5dbd925bc98379aef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d1ce157cf51b70bad82c23e082d5067"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga8d1ce157cf51b70bad82c23e082d5067">sftp_rewind</a> (sftp_file file)</td></tr>
<tr class="memdesc:ga8d1ce157cf51b70bad82c23e082d5067"><td class="mdescLeft"> </td><td class="mdescRight">Rewinds the position of the file pointer to the beginning of the file. <a href="group__libssh__sftp.html#ga8d1ce157cf51b70bad82c23e082d5067">More...</a><br/></td></tr>
<tr class="separator:ga8d1ce157cf51b70bad82c23e082d5067"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab6160ce33fc49d6c38e4a6a66ca0a0b6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gab6160ce33fc49d6c38e4a6a66ca0a0b6">sftp_rmdir</a> (sftp_session sftp, const char *directory)</td></tr>
<tr class="memdesc:gab6160ce33fc49d6c38e4a6a66ca0a0b6"><td class="mdescLeft"> </td><td class="mdescRight">Remove a directoy. <a href="group__libssh__sftp.html#gab6160ce33fc49d6c38e4a6a66ca0a0b6">More...</a><br/></td></tr>
<tr class="separator:gab6160ce33fc49d6c38e4a6a66ca0a0b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f6d52a8422524349efb4de23609e326"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga0f6d52a8422524349efb4de23609e326">sftp_seek</a> (sftp_file file, uint32_t new_offset)</td></tr>
<tr class="memdesc:ga0f6d52a8422524349efb4de23609e326"><td class="mdescLeft"> </td><td class="mdescRight">Seek to a specific location in a file. <a href="group__libssh__sftp.html#ga0f6d52a8422524349efb4de23609e326">More...</a><br/></td></tr>
<tr class="separator:ga0f6d52a8422524349efb4de23609e326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4aa156b5cd180015632384d0f3c8a061"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga4aa156b5cd180015632384d0f3c8a061">sftp_seek64</a> (sftp_file file, uint64_t new_offset)</td></tr>
<tr class="memdesc:ga4aa156b5cd180015632384d0f3c8a061"><td class="mdescLeft"> </td><td class="mdescRight">Seek to a specific location in a file. <a href="group__libssh__sftp.html#ga4aa156b5cd180015632384d0f3c8a061">More...</a><br/></td></tr>
<tr class="separator:ga4aa156b5cd180015632384d0f3c8a061"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga139e445d200c325007d852e52ee2fc78"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga139e445d200c325007d852e52ee2fc78">sftp_server_version</a> (sftp_session sftp)</td></tr>
<tr class="memdesc:ga139e445d200c325007d852e52ee2fc78"><td class="mdescLeft"> </td><td class="mdescRight">Get the version of the SFTP protocol supported by the server. <a href="group__libssh__sftp.html#ga139e445d200c325007d852e52ee2fc78">More...</a><br/></td></tr>
<tr class="separator:ga139e445d200c325007d852e52ee2fc78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabac0bf3340d76857783c3ccfc8014c89"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gabac0bf3340d76857783c3ccfc8014c89">sftp_setstat</a> (sftp_session sftp, const char *file, sftp_attributes attr)</td></tr>
<tr class="memdesc:gabac0bf3340d76857783c3ccfc8014c89"><td class="mdescLeft"> </td><td class="mdescRight">Set file attributes on a file, directory or symbolic link. <a href="group__libssh__sftp.html#gabac0bf3340d76857783c3ccfc8014c89">More...</a><br/></td></tr>
<tr class="separator:gabac0bf3340d76857783c3ccfc8014c89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaad3201367dab4378f71105a0c82ad37d"><td class="memItemLeft" align="right" valign="top">sftp_attributes </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gaad3201367dab4378f71105a0c82ad37d">sftp_stat</a> (sftp_session session, const char *path)</td></tr>
<tr class="memdesc:gaad3201367dab4378f71105a0c82ad37d"><td class="mdescLeft"> </td><td class="mdescRight">Get information about a file or directory. <a href="group__libssh__sftp.html#gaad3201367dab4378f71105a0c82ad37d">More...</a><br/></td></tr>
<tr class="separator:gaad3201367dab4378f71105a0c82ad37d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8654c581979d66fcf5cf1f1b67226cd2"><td class="memItemLeft" align="right" valign="top">sftp_statvfs_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga8654c581979d66fcf5cf1f1b67226cd2">sftp_statvfs</a> (sftp_session sftp, const char *path)</td></tr>
<tr class="memdesc:ga8654c581979d66fcf5cf1f1b67226cd2"><td class="mdescLeft"> </td><td class="mdescRight">Get information about a mounted file system. <a href="group__libssh__sftp.html#ga8654c581979d66fcf5cf1f1b67226cd2">More...</a><br/></td></tr>
<tr class="separator:ga8654c581979d66fcf5cf1f1b67226cd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae98c62de2f020bb54361a8a16189c398"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gae98c62de2f020bb54361a8a16189c398">sftp_statvfs_free</a> (sftp_statvfs_t statvfs_o)</td></tr>
<tr class="memdesc:gae98c62de2f020bb54361a8a16189c398"><td class="mdescLeft"> </td><td class="mdescRight">Free the memory of an allocated statvfs. <a href="group__libssh__sftp.html#gae98c62de2f020bb54361a8a16189c398">More...</a><br/></td></tr>
<tr class="separator:gae98c62de2f020bb54361a8a16189c398"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga010212bcabdccf36a34befe14c04a472"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga010212bcabdccf36a34befe14c04a472">sftp_symlink</a> (sftp_session sftp, const char *target, const char *dest)</td></tr>
<tr class="memdesc:ga010212bcabdccf36a34befe14c04a472"><td class="mdescLeft"> </td><td class="mdescRight">Create a symbolic link. <a href="group__libssh__sftp.html#ga010212bcabdccf36a34befe14c04a472">More...</a><br/></td></tr>
<tr class="separator:ga010212bcabdccf36a34befe14c04a472"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga50e720c525e05226cb3852440a96c937"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga50e720c525e05226cb3852440a96c937">sftp_tell</a> (sftp_file file)</td></tr>
<tr class="memdesc:ga50e720c525e05226cb3852440a96c937"><td class="mdescLeft"> </td><td class="mdescRight">Report current byte position in file. <a href="group__libssh__sftp.html#ga50e720c525e05226cb3852440a96c937">More...</a><br/></td></tr>
<tr class="separator:ga50e720c525e05226cb3852440a96c937"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec69c525fcf3b89d6c754043d2513833"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gaec69c525fcf3b89d6c754043d2513833">sftp_tell64</a> (sftp_file file)</td></tr>
<tr class="memdesc:gaec69c525fcf3b89d6c754043d2513833"><td class="mdescLeft"> </td><td class="mdescRight">Report current byte position in file. <a href="group__libssh__sftp.html#gaec69c525fcf3b89d6c754043d2513833">More...</a><br/></td></tr>
<tr class="separator:gaec69c525fcf3b89d6c754043d2513833"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5fc1fa851dc7cde5dd070d5410edf6b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga5fc1fa851dc7cde5dd070d5410edf6b1">sftp_unlink</a> (sftp_session sftp, const char *file)</td></tr>
<tr class="memdesc:ga5fc1fa851dc7cde5dd070d5410edf6b1"><td class="mdescLeft"> </td><td class="mdescRight">Unlink (delete) a file. <a href="group__libssh__sftp.html#ga5fc1fa851dc7cde5dd070d5410edf6b1">More...</a><br/></td></tr>
<tr class="separator:ga5fc1fa851dc7cde5dd070d5410edf6b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf06b62c568c89b69cc31b119be2aee7b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#gaf06b62c568c89b69cc31b119be2aee7b">sftp_utimes</a> (sftp_session sftp, const char *file, const struct timeval *times)</td></tr>
<tr class="memdesc:gaf06b62c568c89b69cc31b119be2aee7b"><td class="mdescLeft"> </td><td class="mdescRight">Change the last modification and access time of a file. <a href="group__libssh__sftp.html#gaf06b62c568c89b69cc31b119be2aee7b">More...</a><br/></td></tr>
<tr class="separator:gaf06b62c568c89b69cc31b119be2aee7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga744054eb0dcfb0feed5ba81ed01ad3c0"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__sftp.html#ga744054eb0dcfb0feed5ba81ed01ad3c0">sftp_write</a> (sftp_file file, const void *buf, size_t count)</td></tr>
<tr class="memdesc:ga744054eb0dcfb0feed5ba81ed01ad3c0"><td class="mdescLeft"> </td><td class="mdescRight">Write to a file using an opened sftp file handle. <a href="group__libssh__sftp.html#ga744054eb0dcfb0feed5ba81ed01ad3c0">More...</a><br/></td></tr>
<tr class="separator:ga744054eb0dcfb0feed5ba81ed01ad3c0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SFTP handling functions. </p>
<p>SFTP commands are channeled by the ssh sftp subsystem. Every packet is sent/read using a sftp_packet type structure. Related to these packets, most of the server answers are messages having an ID and a message specific part. It is described by sftp_message when reading a message, the sftp system puts it into the queue, so the process having asked for it can fetch it, while continuing to read for other messages (it is unspecified in which order messages may be sent back to the client </p>
</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>
