← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/gnome-vfs-20-gnome-vfs-file-advanced-ops.html

  • 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/html/gnome-vfs-20-gnome-vfs-file-advanced-ops.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>Backend-Specific Operations</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
8
 
<link rel="up" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
9
 
<link rel="prev" href="gnome-vfs-20-gnome-vfs-monitor.html" title="Monitoring">
10
 
<link rel="next" href="gnome-vfs-file-async-ops.html" title="Asynchronous Operations">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
14
 
<link rel="chapter" href="data-types.html" title="Basic Data Types">
15
 
<link rel="chapter" href="gnome-vfs-basic-file-ops.html" title="File Operations">
16
 
<link rel="chapter" href="gnome-vfs-directory-ops.html" title="Directory-Specific Operations">
17
 
<link rel="chapter" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
18
 
<link rel="chapter" href="gnome-vfs-file-async-ops.html" title="Asynchronous Operations">
19
 
<link rel="chapter" href="volumes.html" title="Volumes and Drives Handling">
20
 
<link rel="chapter" href="networking.html" title="Networking">
21
 
<link rel="chapter" href="mime-registry.html" title="MIME Registry">
22
 
<link rel="chapter" href="modules.html" title="Filesystem Modules">
23
 
</head>
24
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
25
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
26
 
<tr valign="middle">
27
 
<td><a accesskey="p" href="gnome-vfs-20-gnome-vfs-monitor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
28
 
<td><a accesskey="u" href="gnome-vfs-file-and-dirs-ops.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
29
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
30
 
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
31
 
<td><a accesskey="n" href="gnome-vfs-file-async-ops.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
32
 
</tr>
33
 
<tr><td colspan="5" class="shortcuts">
34
 
<a href="#gnome-vfs-20-gnome-vfs-file-advanced-ops.synopsis" class="shortcut">Top</a>
35
 
                 | 
36
 
                <a href="#gnome-vfs-20-gnome-vfs-file-advanced-ops.description" class="shortcut">Description</a>
37
 
</td></tr>
38
 
</table>
39
 
<div class="refentry" lang="en">
40
 
<a name="gnome-vfs-20-gnome-vfs-file-advanced-ops"></a><div class="titlepage"></div>
41
 
<div class="refnamediv"><table width="100%"><tr>
42
 
<td valign="top">
43
 
<h2><span class="refentrytitle"><a name="gnome-vfs-20-gnome-vfs-file-advanced-ops.top_of_page"></a>Backend-Specific Operations</span></h2>
44
 
<p>Backend-Specific Operations — Execute backend-specific operations</p>
45
 
</td>
46
 
<td valign="top" align="right"></td>
47
 
</tr></table></div>
48
 
<div class="refsynopsisdiv">
49
 
<a name="gnome-vfs-20-gnome-vfs-file-advanced-ops.synopsis"></a><h2>Synopsis</h2>
50
 
<pre class="synopsis">
51
 
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      <a class="link" href="gnome-vfs-20-gnome-vfs-file-advanced-ops.html#gnome-vfs-file-control" title="gnome_vfs_file_control ()">gnome_vfs_file_control</a>              (GnomeVFSHandle *handle,
52
 
                                                         const char *operation,
53
 
                                                         gpointer operation_data);
54
 
</pre>
55
 
</div>
56
 
<div class="refsect1" lang="en">
57
 
<a name="gnome-vfs-20-gnome-vfs-file-advanced-ops.description"></a><h2>Description</h2>
58
 
<p>
59
 
  Advanced file operations allow you to execute backend-specific commands.
60
 
  Currently, none of the <span class="type">GnomeVFSModules</span> shipped with GnomeVFS includes
61
 
  useful operations, but they allow sophisticated module-specific code
62
 
  that can not be added to GnomeVFS because it would break abstraction.
63
 
</p>
64
 
</div>
65
 
<div class="refsect1" lang="en">
66
 
<a name="gnome-vfs-20-gnome-vfs-file-advanced-ops.details"></a><h2>Details</h2>
67
 
<div class="refsect2" lang="en">
68
 
<a name="gnome-vfs-file-control"></a><h3>gnome_vfs_file_control ()</h3>
69
 
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      gnome_vfs_file_control              (GnomeVFSHandle *handle,
70
 
                                                         const char *operation,
71
 
                                                         gpointer operation_data);</pre>
72
 
<p>
73
 
Execute a backend dependent operation specified by the string <em class="parameter"><code>operation</code></em>.
74
 
This is typically used for specialized vfs backends that need additional
75
 
operations that gnome-vfs doesn't have. Compare it to the unix call <code class="function">ioctl()</code>.
76
 
The format of <em class="parameter"><code>operation_data</code></em> depends on the operation. Operation that are
77
 
backend specific are normally namespaced by their module name.</p>
78
 
<p>
79
 
</p>
80
 
<div class="variablelist"><table border="0">
81
 
<col align="left" valign="top">
82
 
<tbody>
83
 
<tr>
84
 
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
85
 
<td> handle of the file to affect.
86
 
</td>
87
 
</tr>
88
 
<tr>
89
 
<td><p><span class="term"><em class="parameter"><code>operation</code></em> :</span></p></td>
90
 
<td> operation to execute.
91
 
</td>
92
 
</tr>
93
 
<tr>
94
 
<td><p><span class="term"><em class="parameter"><code>operation_data</code></em> :</span></p></td>
95
 
<td> data needed to execute the operation.
96
 
</td>
97
 
</tr>
98
 
<tr>
99
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
100
 
<td> an integer representing the success of the operation.
101
 
</td>
102
 
</tr>
103
 
</tbody>
104
 
</table></div>
105
 
</div>
106
 
</div>
107
 
</div>
108
 
<div class="footer">
109
 
<hr>
110
 
          Generated by GTK-Doc V1.11</div>
111
 
</body>
112
 
</html>