<!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 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="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="headertitle">
<div class="title">sftp.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="sftp_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> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This file is part of the SSH Library</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2003-2008 by Aris Adamantiadis</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * The SSH Library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as published by</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the Free Software Foundation; either version 2.1 of the License, or (at your</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The SSH Library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * along with the SSH Library; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MA 02111-1307, USA.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifndef SFTP_H</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_H</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <sys/types.h></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "libssh.h"</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifdef _WIN32</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef uid_t</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span> <span class="keyword">typedef</span> uint32_t uid_t;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#endif </span><span class="comment">/* uid_t */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef gid_t</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span> <span class="keyword">typedef</span> uint32_t gid_t;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif </span><span class="comment">/* gid_t */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span><span class="preprocessor">#ifdef _MSC_VER</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef ssize_t</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"></span> <span class="keyword">typedef</span> _W64 SSIZE_T ssize_t;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#endif </span><span class="comment">/* ssize_t */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* _MSC_VER */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* _WIN32 */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_attributes_struct* sftp_attributes;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_client_message_struct* sftp_client_message;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_dir_struct* sftp_dir;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_ext_struct *sftp_ext;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_file_struct* sftp_file;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_message_struct* sftp_message;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_packet_struct* sftp_packet;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_request_queue_struct* sftp_request_queue;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_session_struct* sftp_session;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_status_message_struct* sftp_status_message;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>sftp_statvfs_struct* sftp_statvfs_t;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">struct </span>sftp_session_struct {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  ssh_session session;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  ssh_channel channel;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">int</span> server_version;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">int</span> client_version;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> version;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  sftp_request_queue queue;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  uint32_t id_counter;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> errnum;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> **handles;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  sftp_ext ext;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">struct </span>sftp_packet_struct {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  sftp_session sftp;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  uint8_t type;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  ssh_buffer payload;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/* file handler */</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">struct </span>sftp_file_struct {</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  sftp_session sftp;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">char</span> *name;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  uint64_t offset;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  ssh_string handle;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">int</span> eof;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">int</span> nonblocking;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">struct </span>sftp_dir_struct {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  sftp_session sftp;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">char</span> *name;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  ssh_string handle; <span class="comment">/* handle to directory */</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  ssh_buffer buffer; <span class="comment">/* contains raw attributes from server which haven't been parsed */</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  uint32_t count; <span class="comment">/* counts the number of following attributes structures into buffer */</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">int</span> eof; <span class="comment">/* end of directory listing */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">struct </span>sftp_message_struct {</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  sftp_session sftp;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  uint8_t packet_type;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  ssh_buffer payload;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  uint32_t id;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> };</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">/* this is a bunch of all data that could be into a message */</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">struct </span>sftp_client_message_struct {</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  sftp_session sftp;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  uint8_t type;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  uint32_t id;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">char</span> *filename; <span class="comment">/* can be "path" */</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  uint32_t flags;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  sftp_attributes attr;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  ssh_string handle;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  uint64_t offset;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  uint32_t len;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">int</span> attr_num;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  ssh_buffer attrbuf; <span class="comment">/* used by sftp_reply_attrs */</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  ssh_string data; <span class="comment">/* can be newpath of rename() */</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> };</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">struct </span>sftp_request_queue_struct {</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  sftp_request_queue next;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  sftp_message message;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> };</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/* SSH_FXP_MESSAGE described into .7 page 26 */</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="keyword">struct </span>sftp_status_message_struct {</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  uint32_t id;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  uint32_t status;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  ssh_string error;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  ssh_string lang;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">char</span> *errormsg;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">char</span> *langmsg;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> };</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="keyword">struct </span>sftp_attributes_struct {</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">char</span> *name;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">char</span> *longname; <span class="comment">/* ls -l output on openssh, not reliable else */</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  uint32_t flags;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  uint8_t type;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  uint64_t size;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  uint32_t uid;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  uint32_t gid;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">char</span> *owner; <span class="comment">/* set if openssh and version 4 */</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">char</span> *group; <span class="comment">/* set if openssh and version 4 */</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  uint32_t permissions;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  uint64_t atime64;</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  uint32_t atime;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  uint32_t atime_nseconds;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  uint64_t createtime;</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  uint32_t createtime_nseconds;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  uint64_t mtime64;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  uint32_t mtime;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  uint32_t mtime_nseconds;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  ssh_string acl;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  uint32_t extended_count;</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  ssh_string extended_type;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  ssh_string extended_data;</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> };</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">struct </span>sftp_statvfs_struct {</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  uint64_t f_bsize; <span class="comment">/* file system block size */</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  uint64_t f_frsize; <span class="comment">/* fundamental fs block size */</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  uint64_t f_blocks; <span class="comment">/* number of blocks (unit f_frsize) */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  uint64_t f_bfree; <span class="comment">/* free blocks in file system */</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  uint64_t f_bavail; <span class="comment">/* free blocks for non-root */</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  uint64_t f_files; <span class="comment">/* total file inodes */</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  uint64_t f_ffree; <span class="comment">/* free file inodes */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  uint64_t f_favail; <span class="comment">/* free file inodes for to non-root */</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  uint64_t f_fsid; <span class="comment">/* file system id */</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  uint64_t f_flag; <span class="comment">/* bit mask of f_flag values */</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  uint64_t f_namemax; <span class="comment">/* maximum filename length */</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> };</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">#define LIBSFTP_VERSION 3</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> LIBSSH_API sftp_session <a class="code" href="group__libssh__sftp.html#ga32c8e182e97352e1aa8a20443c320d7f" title="Start a new sftp session.">sftp_new</a>(ssh_session session);</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> LIBSSH_API <span class="keywordtype">void</span> <a class="code" href="group__libssh__sftp.html#ga155c66639cb3342c7e02a96c8dbf7501" title="Close and deallocate a sftp session.">sftp_free</a>(sftp_session sftp);</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga6eb5a92e33493ec3d9a3576e1617da0d" title="Initialize the sftp session with the server.">sftp_init</a>(sftp_session sftp);</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga1f7fca4091a0075d9e69e47c928f7494" title="Get the last sftp error.">sftp_get_error</a>(sftp_session sftp);</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> LIBSSH_API <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga300723724353ccc490b9c0c55bbee668" title="Get the count of extensions provided by the server.">sftp_extensions_get_count</a>(sftp_session sftp);</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> LIBSSH_API <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__libssh__sftp.html#ga8bcf9a99f395c86c5f99b9a8009e9533" title="Get the name of the extension provided by the server.">sftp_extensions_get_name</a>(sftp_session sftp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> indexn);</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> LIBSSH_API <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__libssh__sftp.html#gad7391f28160aaa883429a3b0aa87e339" title="Get the data of the extension provided by the server.">sftp_extensions_get_data</a>(sftp_session sftp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> indexn);</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga190d0bb19ed8e571ab884d28ee82adfe" title="Check if the given extension is supported.">sftp_extension_supported</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *data);</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> </div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> LIBSSH_API sftp_dir <a class="code" href="group__libssh__sftp.html#gab4290874bdb55796b2823496e0d9b7ec" title="Open a directory used to obtain directory entries.">sftp_opendir</a>(sftp_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> LIBSSH_API sftp_attributes <a class="code" href="group__libssh__sftp.html#ga976ecf6f7d415856e1fd4a0f16ada9b8" title="Get a single file attributes structure of a directory.">sftp_readdir</a>(sftp_session session, sftp_dir dir);</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#gad60f8e71b06eb8fdae2b262bb58f8fec" title="Tell if the directory has reached EOF (End Of File).">sftp_dir_eof</a>(sftp_dir dir);</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> LIBSSH_API sftp_attributes <a class="code" href="group__libssh__sftp.html#gaad3201367dab4378f71105a0c82ad37d" title="Get information about a file or directory.">sftp_stat</a>(sftp_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> </div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> LIBSSH_API sftp_attributes <a class="code" href="group__libssh__sftp.html#ga7e4a3cd284ad72a1c5092c4cef72dfca" title="Get information about a file or directory.">sftp_lstat</a>(sftp_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> </div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> LIBSSH_API sftp_attributes <a class="code" href="group__libssh__sftp.html#gad9cc3609096b1fffa99f59c852415668" title="Get information about a file or directory from a file handle.">sftp_fstat</a>(sftp_file file);</div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span> </div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> LIBSSH_API <span class="keywordtype">void</span> <a class="code" href="group__libssh__sftp.html#gadee9f7af9fc1ad3a0a66c7d97bf7977c" title="Free a sftp attribute structure.">sftp_attributes_free</a>(sftp_attributes file);</div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span> </div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga35551e5b28b192ef8035628d347f7d3e" title="Close a directory handle opened by sftp_opendir().">sftp_closedir</a>(sftp_dir dir);</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> </div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga5878919249d4e8abe59b0ec699eed293" title="Close an open file handle.">sftp_close</a>(sftp_file file);</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> </div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> LIBSSH_API sftp_file <a class="code" href="group__libssh__sftp.html#gab95cb5fe091efcc49dfa7729e4d48010" title="Open a file on the server.">sftp_open</a>(sftp_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> accesstype,</div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  mode_t mode);</div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> </div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> LIBSSH_API <span class="keywordtype">void</span> sftp_file_set_nonblocking(sftp_file handle);</div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> </div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> LIBSSH_API <span class="keywordtype">void</span> sftp_file_set_blocking(sftp_file handle);</div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> </div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> LIBSSH_API ssize_t <a class="code" href="group__libssh__sftp.html#ga6c2bfeb2e089f54c04afe1e484a7fff2" title="Read from a file using an opened sftp file handle.">sftp_read</a>(sftp_file file, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> count);</div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> </div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga4c2cca19b38c54d4b04bb3584b0517cd" title="Start an asynchronous read from a file using an opened sftp file handle.">sftp_async_read_begin</a>(sftp_file file, uint32_t len);</div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> </div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga4399c7ccd8b39a460265047f9d7bc9b1" title="Wait for an asynchronous read to complete and save the data.">sftp_async_read</a>(sftp_file file, <span class="keywordtype">void</span> *data, uint32_t len, uint32_t <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> </div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> LIBSSH_API ssize_t <a class="code" href="group__libssh__sftp.html#ga744054eb0dcfb0feed5ba81ed01ad3c0" title="Write to a file using an opened sftp file handle.">sftp_write</a>(sftp_file file, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> count);</div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> </div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga0f6d52a8422524349efb4de23609e326" title="Seek to a specific location in a file.">sftp_seek</a>(sftp_file file, uint32_t new_offset);</div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> </div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga4aa156b5cd180015632384d0f3c8a061" title="Seek to a specific location in a file.">sftp_seek64</a>(sftp_file file, uint64_t new_offset);</div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> </div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> LIBSSH_API <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="group__libssh__sftp.html#ga50e720c525e05226cb3852440a96c937" title="Report current byte position in file.">sftp_tell</a>(sftp_file file);</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> </div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> LIBSSH_API uint64_t <a class="code" href="group__libssh__sftp.html#gaec69c525fcf3b89d6c754043d2513833" title="Report current byte position in file.">sftp_tell64</a>(sftp_file file);</div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> </div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> LIBSSH_API <span class="keywordtype">void</span> <a class="code" href="group__libssh__sftp.html#ga8d1ce157cf51b70bad82c23e082d5067" title="Rewinds the position of the file pointer to the beginning of the file.">sftp_rewind</a>(sftp_file file);</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> </div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga5fc1fa851dc7cde5dd070d5410edf6b1" title="Unlink (delete) a file.">sftp_unlink</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *file);</div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> </div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#gab6160ce33fc49d6c38e4a6a66ca0a0b6" title="Remove a directoy.">sftp_rmdir</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *directory);</div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> </div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga9cc63cd3efe83edfa3f6a4c5314383cb" title="Create a directory.">sftp_mkdir</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *directory, mode_t mode);</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> </div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga1175bc5bde655df5dbd925bc98379aef" title="Rename or move a file or directory.">sftp_rename</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *original, <span class="keyword">const</span> <span class="keywordtype">char</span> *newname);</div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> </div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#gabac0bf3340d76857783c3ccfc8014c89" title="Set file attributes on a file, directory or symbolic link.">sftp_setstat</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, sftp_attributes attr);</div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> </div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga18abafba9db590408ee2301a27698f2c" title="Change the file owner and group.">sftp_chown</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, uid_t owner, gid_t group);</div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> </div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga311a4bc202d406c916c8b9ad5fe79ac7" title="Change permissions of a file.">sftp_chmod</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, mode_t mode);</div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> </div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#gaf06b62c568c89b69cc31b119be2aee7b" title="Change the last modification and access time of a file.">sftp_utimes</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keyword">const</span> <span class="keyword">struct</span> timeval *times);</div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> </div>
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga010212bcabdccf36a34befe14c04a472" title="Create a symbolic link.">sftp_symlink</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *target, <span class="keyword">const</span> <span class="keywordtype">char</span> *dest);</div>
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> </div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> LIBSSH_API <span class="keywordtype">char</span> *<a class="code" href="group__libssh__sftp.html#ga1ee06dcf214cb4b67195fa7f5ce5027c" title="Read the value of a symbolic link.">sftp_readlink</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> </div>
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span> LIBSSH_API sftp_statvfs_t <a class="code" href="group__libssh__sftp.html#ga8654c581979d66fcf5cf1f1b67226cd2" title="Get information about a mounted file system.">sftp_statvfs</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> </div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> LIBSSH_API sftp_statvfs_t <a class="code" href="group__libssh__sftp.html#ga6f14490f71825904232dc418b7843b9f" title="Get information about a mounted file system.">sftp_fstatvfs</a>(sftp_file file);</div>
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span> </div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> LIBSSH_API <span class="keywordtype">void</span> <a class="code" href="group__libssh__sftp.html#gae98c62de2f020bb54361a8a16189c398" title="Free the memory of an allocated statvfs.">sftp_statvfs_free</a>(sftp_statvfs_t statvfs_o);</div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> </div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> LIBSSH_API <span class="keywordtype">char</span> *<a class="code" href="group__libssh__sftp.html#ga69b4d6f723565e3fcac2b37159262af5" title="Canonicalize a sftp path.">sftp_canonicalize_path</a>(sftp_session sftp, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span> </div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__sftp.html#ga139e445d200c325007d852e52ee2fc78" title="Get the version of the SFTP protocol supported by the server.">sftp_server_version</a>(sftp_session sftp);</div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span> </div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="preprocessor">#ifdef WITH_SERVER</span></div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span> LIBSSH_API sftp_session sftp_server_new(ssh_session session, ssh_channel chan);</div>
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span> </div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span> LIBSSH_API <span class="keywordtype">int</span> sftp_server_init(sftp_session sftp);</div>
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="preprocessor">#endif </span><span class="comment">/* WITH_SERVER */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment">/* this is not a public interface */</span></div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="preprocessor">#define SFTP_HANDLES 256</span></div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="preprocessor"></span>sftp_packet sftp_packet_read(sftp_session sftp);</div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="keywordtype">int</span> sftp_packet_write(sftp_session sftp,uint8_t type, ssh_buffer payload);</div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="keywordtype">void</span> sftp_packet_free(sftp_packet packet);</div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="keywordtype">int</span> buffer_add_attributes(ssh_buffer buffer, sftp_attributes attr);</div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span> sftp_attributes sftp_parse_attr(sftp_session session, ssh_buffer buf,<span class="keywordtype">int</span> expectname);</div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment">/* sftpserver.c */</span></div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span> </div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span> sftp_client_message sftp_get_client_message(sftp_session sftp);</div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="keywordtype">void</span> sftp_client_message_free(sftp_client_message msg);</div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="keywordtype">int</span> sftp_reply_name(sftp_client_message msg, <span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span>  sftp_attributes attr);</div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="keywordtype">int</span> sftp_reply_handle(sftp_client_message msg, ssh_string handle);</div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span> ssh_string sftp_handle_alloc(sftp_session sftp, <span class="keywordtype">void</span> *info);</div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="keywordtype">int</span> sftp_reply_attr(sftp_client_message msg, sftp_attributes attr);</div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="keywordtype">void</span> *sftp_handle(sftp_session sftp, ssh_string handle);</div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="keywordtype">int</span> sftp_reply_status(sftp_client_message msg, uint32_t status, <span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="keywordtype">int</span> sftp_reply_names_add(sftp_client_message msg, <span class="keyword">const</span> <span class="keywordtype">char</span> *file,</div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *longname, sftp_attributes attr);</div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="keywordtype">int</span> sftp_reply_names(sftp_client_message msg);</div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="keywordtype">int</span> sftp_reply_data(sftp_client_message msg, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="keywordtype">void</span> sftp_handle_remove(sftp_session sftp, <span class="keywordtype">void</span> *handle);</div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span> </div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment">/* SFTP commands and constants */</span></div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="preprocessor">#define SSH_FXP_INIT 1</span></div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_VERSION 2</span></div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_OPEN 3</span></div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_CLOSE 4</span></div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_READ 5</span></div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_WRITE 6</span></div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_LSTAT 7</span></div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_FSTAT 8</span></div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_SETSTAT 9</span></div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_FSETSTAT 10</span></div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_OPENDIR 11</span></div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_READDIR 12</span></div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_REMOVE 13</span></div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_MKDIR 14</span></div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_RMDIR 15</span></div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_REALPATH 16</span></div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_STAT 17</span></div>
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_RENAME 18</span></div>
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_READLINK 19</span></div>
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_SYMLINK 20</span></div>
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="preprocessor">#define SSH_FXP_STATUS 101</span></div>
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_HANDLE 102</span></div>
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_DATA 103</span></div>
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_NAME 104</span></div>
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_ATTRS 105</span></div>
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="preprocessor">#define SSH_FXP_EXTENDED 200</span></div>
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXP_EXTENDED_REPLY 201</span></div>
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment">/* attributes */</span></div>
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment">/* sftp draft is completely braindead : version 3 and 4 have different flags for same constants */</span></div>
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment">/* and even worst, version 4 has same flag for 2 different constants */</span></div>
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment">/* follow up : i won't develop any sftp4 compliant library before having a clarification */</span></div>
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span> </div>
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="preprocessor">#define SSH_FILEXFER_ATTR_SIZE 0x00000001</span></div>
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_PERMISSIONS 0x00000004</span></div>
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008</span></div>
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_ACMODTIME 0x00000008</span></div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_CREATETIME 0x00000010</span></div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020</span></div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_ACL 0x00000040</span></div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080</span></div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100</span></div>
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_EXTENDED 0x80000000</span></div>
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_ATTR_UIDGID 0x00000002</span></div>
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment">/* types */</span></div>
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="preprocessor">#define SSH_FILEXFER_TYPE_REGULAR 1</span></div>
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_TYPE_DIRECTORY 2</span></div>
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_TYPE_SYMLINK 3</span></div>
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_TYPE_SPECIAL 4</span></div>
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FILEXFER_TYPE_UNKNOWN 5</span></div>
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00854"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga8db0fdad334ce6e77c7a698947c2f118"> 854</a></span> <span class="preprocessor">#define SSH_FX_OK 0</span></div>
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00856"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga9e0923585f3a60c782d483863799f01f"> 856</a></span> <span class="preprocessor">#define SSH_FX_EOF 1</span></div>
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00858"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga9bcfb9bfc410f1493424c4492fea8016"> 858</a></span> <span class="preprocessor">#define SSH_FX_NO_SUCH_FILE 2</span></div>
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00860"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga75c7f502ec17cd22a5777997e0776694"> 860</a></span> <span class="preprocessor">#define SSH_FX_PERMISSION_DENIED 3</span></div>
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00862"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#gad01f42405d742709739ad708277004c3"> 862</a></span> <span class="preprocessor">#define SSH_FX_FAILURE 4</span></div>
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00864"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga12cb3bf50e715473c2ca5ccb69965cf3"> 864</a></span> <span class="preprocessor">#define SSH_FX_BAD_MESSAGE 5</span></div>
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00866"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga3da0fc47440139efceb8a9220e31875c"> 866</a></span> <span class="preprocessor">#define SSH_FX_NO_CONNECTION 6</span></div>
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00868"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga721ad225dfe6638384e388c5fe1cb42b"> 868</a></span> <span class="preprocessor">#define SSH_FX_CONNECTION_LOST 7</span></div>
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00870"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga383f2d50fd2cae076c270f84ffe6c044"> 870</a></span> <span class="preprocessor">#define SSH_FX_OP_UNSUPPORTED 8</span></div>
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00872"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#gadb2010df724d8c8d0b5414a63b7ac859"> 872</a></span> <span class="preprocessor">#define SSH_FX_INVALID_HANDLE 9</span></div>
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00874"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga473dd6f7267ff262441e8a2aab3c33c8"> 874</a></span> <span class="preprocessor">#define SSH_FX_NO_SUCH_PATH 10</span></div>
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00876"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#gabae8a18fd96320cc78ea052eb269ed38"> 876</a></span> <span class="preprocessor">#define SSH_FX_FILE_ALREADY_EXISTS 11</span></div>
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00878"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga0e734958d6410066f1b1adf503ce52d8"> 878</a></span> <span class="preprocessor">#define SSH_FX_WRITE_PROTECT 12</span></div>
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00880"></a><span class="lineno"><a class="code" href="group__libssh__sftp.html#ga8e7ba323d3bd55c416d9b4529f8e8d82"> 880</a></span> <span class="preprocessor">#define SSH_FX_NO_MEDIA 13</span></div>
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment">/* file flags */</span></div>
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="preprocessor">#define SSH_FXF_READ 0x01</span></div>
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_WRITE 0x02</span></div>
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_APPEND 0x04</span></div>
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_CREAT 0x08</span></div>
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_TRUNC 0x10</span></div>
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_EXCL 0x20</span></div>
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_TEXT 0x40</span></div>
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment">/* rename flags */</span></div>
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="preprocessor">#define SSH_FXF_RENAME_OVERWRITE 0x00000001</span></div>
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_RENAME_ATOMIC 0x00000002</span></div>
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXF_RENAME_NATIVE 0x00000004</span></div>
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="preprocessor">#define SFTP_OPEN SSH_FXP_OPEN</span></div>
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_CLOSE SSH_FXP_CLOSE</span></div>
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_READ SSH_FXP_READ</span></div>
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_WRITE SSH_FXP_WRITE</span></div>
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_LSTAT SSH_FXP_LSTAT</span></div>
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_FSTAT SSH_FXP_FSTAT</span></div>
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_SETSTAT SSH_FXP_SETSTAT</span></div>
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_FSETSTAT SSH_FXP_FSETSTAT</span></div>
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_OPENDIR SSH_FXP_OPENDIR</span></div>
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_READDIR SSH_FXP_READDIR</span></div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_REMOVE SSH_FXP_REMOVE</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_MKDIR SSH_FXP_MKDIR</span></div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_RMDIR SSH_FXP_RMDIR</span></div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_REALPATH SSH_FXP_REALPATH</span></div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_STAT SSH_FXP_STAT</span></div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_RENAME SSH_FXP_RENAME</span></div>
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_READLINK SSH_FXP_READLINK</span></div>
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span> <span class="preprocessor"></span><span class="preprocessor">#define SFTP_SYMLINK SSH_FXP_SYMLINK</span></div>
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span> <span class="comment">/* openssh flags */</span></div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span> <span class="preprocessor">#define SSH_FXE_STATVFS_ST_RDONLY 0x1 </span><span class="comment">/* read-only */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_FXE_STATVFS_ST_NOSUID 0x2 </span><span class="comment">/* no setuid */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="preprocessor"></span>} ;</div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="preprocessor">#endif </span><span class="comment">/* SFTP_H */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment">/* vim: set ts=2 sw=2 et cindent: */</span></div>
</div><!-- fragment --></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>
