doc/xml/gnome-vfs-file-trunc-ops.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-file-trunc-ops">
   2 <refmeta>
   3 <refentrytitle>Truncating Files</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>Truncating Files</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-truncate">gnome_vfs_truncate</link>           (const <link linkend="gchar">gchar</link> *text_uri,
  19                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);
  20 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-truncate-uri">gnome_vfs_truncate_uri</link>       (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
  21                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);
  22 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-truncate-handle">gnome_vfs_truncate_handle</link>    (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle,
  23                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);
  24 </synopsis>
  25 </refsynopsisdiv>
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35 <refsect1>
  36 <title>Description</title>
  37 <para>
  38
  39 </para>
  40 </refsect1>
  41
  42 <refsect1>
  43 <title>Details</title>
  44 <refsect2>
  45 <title><anchor id="gnome-vfs-truncate"/>gnome_vfs_truncate ()</title>
  46 <indexterm><primary>gnome_vfs_truncate</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_truncate           (const <link linkend="gchar">gchar</link> *text_uri,
  47                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);</programlisting>
  48 <para>
  49 Truncate the file at <parameter>text_uri</parameter> to <parameter>length</parameter> bytes.</para>
  50 <para>
  51
  52 </para><variablelist role="params">
  53 <varlistentry><term><parameter>text_uri</parameter>&nbsp;:</term>
  54 <listitem><simpara> URI of the file to be truncated
  55 </simpara></listitem></varlistentry>
  56 <varlistentry><term><parameter>length</parameter>&nbsp;:</term>
  57 <listitem><simpara> length of the new file at <parameter>text_uri</parameter>
  58 </simpara></listitem></varlistentry>
  59 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
  60 </simpara></listitem></varlistentry>
  61 </variablelist></refsect2>
  62 <refsect2>
  63 <title><anchor id="gnome-vfs-truncate-uri"/>gnome_vfs_truncate_uri ()</title>
  64 <indexterm><primary>gnome_vfs_truncate_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_truncate_uri       (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
  65                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);</programlisting>
  66 <para>
  67 Truncate the file at <parameter>uri</parameter> to be only <parameter>length</parameter> bytes. Data past <parameter>length</parameter>
  68 bytes will be discarded.</para>
  69 <para>
  70
  71 </para><variablelist role="params">
  72 <varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
  73 <listitem><simpara> URI of the file to be truncated
  74 </simpara></listitem></varlistentry>
  75 <varlistentry><term><parameter>length</parameter>&nbsp;:</term>
  76 <listitem><simpara> length of the new file at <parameter>uri</parameter>
  77 </simpara></listitem></varlistentry>
  78 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
  79 </simpara></listitem></varlistentry>
  80 </variablelist></refsect2>
  81 <refsect2>
  82 <title><anchor id="gnome-vfs-truncate-handle"/>gnome_vfs_truncate_handle ()</title>
  83 <indexterm><primary>gnome_vfs_truncate_handle</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_truncate_handle    (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle,
  84                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);</programlisting>
  85 <para>
  86 Truncate the file pointed to be <parameter>handle</parameter> to be only <parameter>length</parameter> bytes.
  87 Data past <parameter>length</parameter> bytes will be discarded.</para>
  88 <para>
  89
  90 </para><variablelist role="params">
  91 <varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
  92 <listitem><simpara> a handle to the file to be truncated
  93 </simpara></listitem></varlistentry>
  94 <varlistentry><term><parameter>length</parameter>&nbsp;:</term>
  95 <listitem><simpara> length of the new file the handle is open to
  96 </simpara></listitem></varlistentry>
  97 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
  98 </simpara></listitem></varlistentry>
  99 </variablelist></refsect2>
 100
 101 </refsect1>
 102
 103
 104
 105
 106 </refentry>