/usr/share/gtk-doc/html/pygnomevfs/class-gnomevfs-handle.html is in python-gnome2-doc 2.28.1+dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomevfs.Handle</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="Python gnomevfs Reference Manual"><link rel="up" href="gnomevfs-class-reference.html" title="The gnomevfs class reference"><link rel="prev" href="class-gnomevfs-fileinfo.html" title="gnomevfs.FileInfo"><link rel="next" href="class-gnomevfs-uri.html" title="gnomevfs.URI"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gnomevfs.Handle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gnomevfs-fileinfo.html">Prev</a> </td><th width="60%" align="center">The gnomevfs class reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gnomevfs-uri.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gnomevfs.Handle"><a name="class-gnomevfs-handle"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomevfs.Handle</h2><p>gnomevfs.Handle — Object representing an open file</p></div><div class="refsect1" title="Synopsis"><a name="id470122"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gnomevfs.Handle</span></span>:
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#constructor-gnomevfs-handle">gnomevfs.Handle</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>open_mode</code></strong></span><span class="initializer">=gnomevfs.OPEN_READ</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--close" title="gnomevfs.Handle.close">close</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--get_file_info" title="gnomevfs.Handle.get_file_info">get_file_info</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>options</code></strong></span><span class="initializer">=gnomevfs.FILE_INFO_DEFAULT</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--read" title="gnomevfs.Handle.read">read</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>bytes</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--seek" title="gnomevfs.Handle.seek">seek</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>whence</code></strong></span><span class="initializer">=gnomevfs.SEEK_START</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--tell" title="gnomevfs.Handle.tell">tell</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--truncate" title="gnomevfs.Handle.truncate">truncate</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#method-gnomevfs-handle--write" title="gnomevfs.Handle.write">write</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>buffer</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id451644"></a><h2>Description</h2><p></p></div><div class="refsect1" title="Constructor"><a name="id451653"></a><h2>Constructor</h2><div class="refsect2"><a name="constructor-gnomevfs-handle"></a><pre class="programlisting">
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gnomevfs-handle.html#constructor-gnomevfs-handle">gnomevfs.Handle</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>open_mode</code></strong></span><span class="initializer">=gnomevfs.OPEN_READ</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI to open.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>open_mode</code></strong>:</span></p></td><td>Or'd set of <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-openmode" title="gnomevfs Open Mode Constants">open mode flags</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>the new <a class="link" href="class-gnomevfs-handle.html" title="gnomevfs.Handle"><code class="classname">gnomevfs.Handle</code></a></td></tr></tbody></table><p></p></div></div><div class="refsect1" title="Methods"><a name="id455456"></a><h2>Methods</h2><div class="refsect2" title="gnomevfs.Handle.close"><a name="method-gnomevfs-handle--close"></a><h3>gnomevfs.Handle.close</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">close</span>(<span class="methodparam"></span>)</code>
</pre><p>Close the file associated with this handle.</p></div><div class="refsect2" title="gnomevfs.Handle.get_file_info"><a name="method-gnomevfs-handle--get_file_info"></a><h3>gnomevfs.Handle.get_file_info</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">get_file_info</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>options</code></strong></span><span class="initializer">=gnomevfs.FILE_INFO_DEFAULT</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>options</code></strong>:</span></p></td><td>Or'd set of <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-fileinfo-options" title="gnomevfs FileInfo Options">file info options</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A <a class="link" href="class-gnomevfs-fileinfo.html" title="gnomevfs.FileInfo">gnomevfs.FileInfo</a>.</td></tr></tbody></table><p>Get information about the file, persuant to the options given.</p></div><div class="refsect2" title="gnomevfs.Handle.read"><a name="method-gnomevfs-handle--read"></a><h3>gnomevfs.Handle.read</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">read</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>bytes</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>bytes</code></strong>:</span></p></td><td>The number of bytes to read</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A string containing the data.</td></tr></tbody></table><p>Read <strong class="parameter"><code>bytes</code></strong> from file. The actual number of bytes read may be less than this, so you may need to check the length of the string returned.</p></div><div class="refsect2" title="gnomevfs.Handle.seek"><a name="method-gnomevfs-handle--seek"></a><h3>gnomevfs.Handle.seek</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">seek</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>whence</code></strong></span><span class="initializer">=gnomevfs.SEEK_START</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>offset</code></strong>:</span></p></td><td>The number of bytes to offset from the position specified by <strong class="parameter"><code>whence</code></strong>. This can be either positive or negative.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>whence</code></strong>:</span></p></td><td>The <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-seekmode" title="gnomevfs Seek Constants">start position</a>.</td></tr></tbody></table><p>Set the current position for reading/writing.</p></div><div class="refsect2" title="gnomevfs.Handle.tell"><a name="method-gnomevfs-handle--tell"></a><h3>gnomevfs.Handle.tell</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">tell</span>(<span class="methodparam"></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A long specifying the current byte position.</td></tr></tbody></table><p>Returns the current position in the file. This is the position at which any reads or writes will begin at.</p></div><div class="refsect2" title="gnomevfs.Handle.truncate"><a name="method-gnomevfs-handle--truncate"></a><h3>gnomevfs.Handle.truncate</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">truncate</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>length</code></strong>:</span></p></td><td>The length to truncate to.</td></tr></tbody></table><p>Truncates the file to the length specified.</p></div><div class="refsect2" title="gnomevfs.Handle.write"><a name="method-gnomevfs-handle--write"></a><h3>gnomevfs.Handle.write</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">write</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>buffer</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>buffer</code></strong>:</span></p></td><td>The buffer to write to the file.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>The number of bytes written.</td></tr></tbody></table><p>Write <strong class="parameter"><code>buffer</code></strong> to the file. The number of bytes actually written may be less than the buffer, as is provided as the return value.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gnomevfs-fileinfo.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gnomevfs-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gnomevfs-uri.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gnomevfs.FileInfo </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomevfs.URI</td></tr></table></div></body></html>
|