<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="Up" href="Ftp.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="Ftp" rel="Chapter" href="Ftp.html"><title>Ftp.File</title> </head> <body> <div class="navbar"> <a class="up" href="Ftp.html" title="Ftp">Up</a> </div> <h1>Module <a href="type_Ftp.File.html">Ftp.File</a></h1> <pre><span class="keyword">module</span> File: <code class="type"><a href="Ftp.FILE.html">FILE</a></code><code class="type"> </code></pre><div class="info module top"> High-level functions to access files via ftp.<br> </div> <hr width="100%"> <pre><span id="VALls"><span class="keyword">val</span> ls</span> : <code class="type">string -> (string * <a href="Ftp.html#TYPEstats">Ftp.stats</a>) list</code></pre><div class="info "> List files and their properties of a directory.<br> </div> <pre><span id="TYPEfile_descr"><span class="keyword">type</span> <code class="type"></code>file_descr</span> </pre> <div class="info "> Type of file descriptors.<br> </div> <pre><code><span id="TYPEopen_flag"><span class="keyword">type</span> <code class="type"></code>open_flag</span> = </code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.O_RDONLY"><span class="constructor">O_RDONLY</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.O_WRONLY"><span class="constructor">O_WRONLY</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.O_RDWR"><span class="constructor">O_RDWR</span></span></code></td> </tr></table> <div class="info "> Open files: what for?<br> </div> <pre><span id="VALopenfile"><span class="keyword">val</span> openfile</span> : <code class="type">string -> <a href="Ftp.FILE.html#TYPEopen_flag">open_flag</a> list -> <a href="Ftp.html#TYPEfile_perm">Ftp.file_perm</a> -> <a href="Ftp.FILE.html#TYPEfile_descr">file_descr</a></code></pre><div class="info "> <code class="code">openfile name flags perms</code> opens the file named <code class="code">name</code> with flags <code class="code">flags</code> and mode <code class="code">mode</code> (in octal).<br> </div> <pre><span id="VALclose"><span class="keyword">val</span> close</span> : <code class="type"><a href="Ftp.FILE.html#TYPEfile_descr">file_descr</a> -> unit</code></pre><div class="info "> Close a previously opened file.<br> </div> <pre><span id="VALread"><span class="keyword">val</span> read</span> : <code class="type"><a href="Ftp.FILE.html#TYPEfile_descr">file_descr</a> -> string -> int -> int -> int</code></pre><div class="info "> Read data in an opened file.<br> </div> <pre><code><span id="TYPEseek_command"><span class="keyword">type</span> <code class="type"></code>seek_command</span> = </code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTseek_command.SEEK_SET"><span class="constructor">SEEK_SET</span></span></code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >indicates positions relative to the beginning of the file</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTseek_command.SEEK_CUR"><span class="constructor">SEEK_CUR</span></span></code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >indicates positions relative to the current position</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTseek_command.SEEK_END"><span class="constructor">SEEK_END</span></span></code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >indicates positions relative to the end of the file</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr></table> <div class="info "> Positioning modes for <code class="code">lseek</code>.<br> </div> <pre><span id="VALlseek"><span class="keyword">val</span> lseek</span> : <code class="type"><a href="Ftp.FILE.html#TYPEfile_descr">file_descr</a> -> int -> <a href="Ftp.FILE.html#TYPEseek_command">seek_command</a> -> int</code></pre><div class="info "> Seek in an opened file.<br> </div> </body></html>