← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« back to all changes in this revision

Viewing changes to doc/xml/gnome-vfs-file-trunc-ops.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gnome-vfs-file-trunc-ops.xml
1
 
<refentry id="gnome-vfs-20-gnome-vfs-file-trunc-ops">
 
1
<refentry id="gnome-vfs-2.0-gnome-vfs-file-trunc-ops">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-file-trunc-ops.top_of_page">Truncating Files</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-2.0-gnome-vfs-file-trunc-ops.top_of_page">Truncating Files</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
6
6
</refmeta>
10
10
<refpurpose>Force files to a particular length</refpurpose>
11
11
</refnamediv>
12
12
 
13
 
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-file-trunc-ops.synopsis" role="synopsis">
 
13
<refsynopsisdiv id="gnome-vfs-2.0-gnome-vfs-file-trunc-ops.synopsis" role="synopsis">
14
14
<title role="synopsis.title">Synopsis</title>
15
15
 
16
16
<synopsis>
31
31
 
32
32
 
33
33
 
34
 
<refsect1 id="gnome-vfs-20-gnome-vfs-file-trunc-ops.description" role="desc">
 
34
<refsect1 id="gnome-vfs-2.0-gnome-vfs-file-trunc-ops.description" role="desc">
35
35
<title role="desc.title">Description</title>
 
36
 
36
37
<para>
37
38
Truncation of files is used to force them to a particular length.
38
39
If a file longer than specified, the trailing bytes are discarded,
40
41
</para>
41
42
</refsect1>
42
43
 
43
 
<refsect1 id="gnome-vfs-20-gnome-vfs-file-trunc-ops.details" role="details">
 
44
<refsect1 id="gnome-vfs-2.0-gnome-vfs-file-trunc-ops.details" role="details">
44
45
<title role="details.title">Details</title>
45
46
<refsect2 id="gnome-vfs-truncate" role="function">
46
47
<title>gnome_vfs_truncate ()</title>
47
 
<indexterm zone="gnome-vfs-truncate"><primary sortas="gnome_vfs_truncate">gnome_vfs_truncate</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_truncate                  (const <link linkend="gchar">gchar</link> *text_uri,
 
48
<indexterm zone="gnome-vfs-truncate"><primary>gnome_vfs_truncate</primary></indexterm>
 
49
<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_truncate                  (const <link linkend="gchar">gchar</link> *text_uri,
48
50
                                                         <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);</programlisting>
49
51
<para>
50
52
Truncate the file at <parameter>text_uri</parameter> to <parameter>length</parameter> bytes.</para>
61
63
</variablelist></refsect2>
62
64
<refsect2 id="gnome-vfs-truncate-uri" role="function">
63
65
<title>gnome_vfs_truncate_uri ()</title>
64
 
<indexterm zone="gnome-vfs-truncate-uri"><primary sortas="gnome_vfs_truncate_uri">gnome_vfs_truncate_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_truncate_uri              (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
66
<indexterm zone="gnome-vfs-truncate-uri"><primary>gnome_vfs_truncate_uri</primary></indexterm>
 
67
<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_truncate_uri              (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
65
68
                                                         <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);</programlisting>
66
69
<para>
67
70
Truncate the file at <parameter>uri</parameter> to be only <parameter>length</parameter> bytes. Data past <parameter>length</parameter>
79
82
</variablelist></refsect2>
80
83
<refsect2 id="gnome-vfs-truncate-handle" role="function">
81
84
<title>gnome_vfs_truncate_handle ()</title>
82
 
<indexterm zone="gnome-vfs-truncate-handle"><primary sortas="gnome_vfs_truncate_handle">gnome_vfs_truncate_handle</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_truncate_handle           (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle,
 
85
<indexterm zone="gnome-vfs-truncate-handle"><primary>gnome_vfs_truncate_handle</primary></indexterm>
 
86
<programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_truncate_handle           (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle,
83
87
                                                         <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length);</programlisting>
84
88
<para>
85
89
Truncate the file pointed to by <parameter>handle</parameter> to be only <parameter>length</parameter> bytes.