← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-file-helpers.xml

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-file-helpers.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-rb-file-helpers">
 
5
<refmeta>
 
6
<refentrytitle>rb-file-helpers</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-file-helpers</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
const <link linkend="char">char</link>* <link linkend="rb-file">rb_file</link>                         (const <link linkend="char">char</link> *filename);
 
22
const <link linkend="char">char</link>* <link linkend="rb-dot-dir">rb_dot_dir</link>                      (void);
 
23
<link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="rb-uri-mkstemp">rb_uri_mkstemp</link>               (const <link linkend="char">char</link> *prefix,
 
24
                                             <link linkend="char">char</link> **uri,
 
25
                                             <link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle);
 
26
<link linkend="char">char</link>*       <link linkend="rb-uri-resolve-symlink">rb_uri_resolve_symlink</link>          (const <link linkend="char">char</link> *uri);
 
27
<link linkend="gboolean">gboolean</link>    <link linkend="rb-uri-is-directory">rb_uri_is_directory</link>             (const <link linkend="char">char</link> *uri);
 
28
<link linkend="gboolean">gboolean</link>    <link linkend="rb-uri-exists">rb_uri_exists</link>                   (const <link linkend="char">char</link> *uri);
 
29
<link linkend="char">char</link>*       <link linkend="rb-uri-resolve-relative">rb_uri_resolve_relative</link>         (const <link linkend="char">char</link> *uri);
 
30
<link linkend="gboolean">gboolean</link>    <link linkend="rb-uri-is-readable">rb_uri_is_readable</link>              (const <link linkend="char">char</link> *uri);
 
31
<link linkend="gboolean">gboolean</link>    <link linkend="rb-uri-is-writable">rb_uri_is_writable</link>              (const <link linkend="char">char</link> *uri);
 
32
<link linkend="void">void</link>        <link linkend="rb-uri-handle-recursively">rb_uri_handle_recursively</link>       (const <link linkend="char">char</link> *uri,
 
33
                                             <link linkend="GFunc">GFunc</link> func,
 
34
                                             <link linkend="gboolean">gboolean</link> *cancelflag,
 
35
                                             <link linkend="gpointer">gpointer</link> user_data);
 
36
<link linkend="void">void</link>        <link linkend="rb-file-helpers-init">rb_file_helpers_init</link>            (void);
 
37
<link linkend="void">void</link>        <link linkend="rb-file-helpers-shutdown">rb_file_helpers_shutdown</link>        (void);
 
38
</synopsis>
 
39
</refsynopsisdiv>
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
<refsect1>
 
50
<title>Description</title>
 
51
<para>
 
52
 
 
53
</para>
 
54
</refsect1>
 
55
 
 
56
<refsect1>
 
57
<title>Details</title>
 
58
<refsect2>
 
59
<title><anchor id="rb-file"/>rb_file ()</title>
 
60
<indexterm><primary>rb_file</primary></indexterm><programlisting>const <link linkend="char">char</link>* rb_file                         (const <link linkend="char">char</link> *filename);</programlisting>
 
61
<para>
 
62
 
 
63
</para><variablelist role="params">
 
64
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
 
65
<listitem><simpara>
 
66
</simpara></listitem></varlistentry>
 
67
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
68
 
 
69
 
 
70
</simpara></listitem></varlistentry>
 
71
</variablelist></refsect2>
 
72
<refsect2>
 
73
<title><anchor id="rb-dot-dir"/>rb_dot_dir ()</title>
 
74
<indexterm><primary>rb_dot_dir</primary></indexterm><programlisting>const <link linkend="char">char</link>* rb_dot_dir                      (void);</programlisting>
 
75
<para>
 
76
 
 
77
</para><variablelist role="params">
 
78
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
79
 
 
80
 
 
81
</simpara></listitem></varlistentry>
 
82
</variablelist></refsect2>
 
83
<refsect2>
 
84
<title><anchor id="rb-uri-mkstemp"/>rb_uri_mkstemp ()</title>
 
85
<indexterm><primary>rb_uri_mkstemp</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> rb_uri_mkstemp               (const <link linkend="char">char</link> *prefix,
 
86
                                             <link linkend="char">char</link> **uri,
 
87
                                             <link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle);</programlisting>
 
88
<para>
 
89
 
 
90
</para><variablelist role="params">
 
91
<varlistentry><term><parameter>prefix</parameter>&nbsp;:</term>
 
92
<listitem><simpara>
 
93
</simpara></listitem></varlistentry>
 
94
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
95
<listitem><simpara>
 
96
</simpara></listitem></varlistentry>
 
97
<varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
 
98
<listitem><simpara>
 
99
</simpara></listitem></varlistentry>
 
100
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
101
 
 
102
 
 
103
</simpara></listitem></varlistentry>
 
104
</variablelist></refsect2>
 
105
<refsect2>
 
106
<title><anchor id="rb-uri-resolve-symlink"/>rb_uri_resolve_symlink ()</title>
 
107
<indexterm><primary>rb_uri_resolve_symlink</primary></indexterm><programlisting><link linkend="char">char</link>*       rb_uri_resolve_symlink          (const <link linkend="char">char</link> *uri);</programlisting>
 
108
<para>
 
109
 
 
110
</para><variablelist role="params">
 
111
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
112
<listitem><simpara>
 
113
</simpara></listitem></varlistentry>
 
114
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
115
 
 
116
 
 
117
</simpara></listitem></varlistentry>
 
118
</variablelist></refsect2>
 
119
<refsect2>
 
120
<title><anchor id="rb-uri-is-directory"/>rb_uri_is_directory ()</title>
 
121
<indexterm><primary>rb_uri_is_directory</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_uri_is_directory             (const <link linkend="char">char</link> *uri);</programlisting>
 
122
<para>
 
123
 
 
124
</para><variablelist role="params">
 
125
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
126
<listitem><simpara>
 
127
</simpara></listitem></varlistentry>
 
128
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
129
 
 
130
 
 
131
</simpara></listitem></varlistentry>
 
132
</variablelist></refsect2>
 
133
<refsect2>
 
134
<title><anchor id="rb-uri-exists"/>rb_uri_exists ()</title>
 
135
<indexterm><primary>rb_uri_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_uri_exists                   (const <link linkend="char">char</link> *uri);</programlisting>
 
136
<para>
 
137
 
 
138
</para><variablelist role="params">
 
139
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
140
<listitem><simpara>
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
143
 
 
144
 
 
145
</simpara></listitem></varlistentry>
 
146
</variablelist></refsect2>
 
147
<refsect2>
 
148
<title><anchor id="rb-uri-resolve-relative"/>rb_uri_resolve_relative ()</title>
 
149
<indexterm><primary>rb_uri_resolve_relative</primary></indexterm><programlisting><link linkend="char">char</link>*       rb_uri_resolve_relative         (const <link linkend="char">char</link> *uri);</programlisting>
 
150
<para>
 
151
 
 
152
</para><variablelist role="params">
 
153
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
154
<listitem><simpara>
 
155
</simpara></listitem></varlistentry>
 
156
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
157
 
 
158
 
 
159
</simpara></listitem></varlistentry>
 
160
</variablelist></refsect2>
 
161
<refsect2>
 
162
<title><anchor id="rb-uri-is-readable"/>rb_uri_is_readable ()</title>
 
163
<indexterm><primary>rb_uri_is_readable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_uri_is_readable              (const <link linkend="char">char</link> *uri);</programlisting>
 
164
<para>
 
165
 
 
166
</para><variablelist role="params">
 
167
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
168
<listitem><simpara>
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
171
 
 
172
 
 
173
</simpara></listitem></varlistentry>
 
174
</variablelist></refsect2>
 
175
<refsect2>
 
176
<title><anchor id="rb-uri-is-writable"/>rb_uri_is_writable ()</title>
 
177
<indexterm><primary>rb_uri_is_writable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_uri_is_writable              (const <link linkend="char">char</link> *uri);</programlisting>
 
178
<para>
 
179
 
 
180
</para><variablelist role="params">
 
181
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
182
<listitem><simpara>
 
183
</simpara></listitem></varlistentry>
 
184
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
185
 
 
186
 
 
187
</simpara></listitem></varlistentry>
 
188
</variablelist></refsect2>
 
189
<refsect2>
 
190
<title><anchor id="rb-uri-handle-recursively"/>rb_uri_handle_recursively ()</title>
 
191
<indexterm><primary>rb_uri_handle_recursively</primary></indexterm><programlisting><link linkend="void">void</link>        rb_uri_handle_recursively       (const <link linkend="char">char</link> *uri,
 
192
                                             <link linkend="GFunc">GFunc</link> func,
 
193
                                             <link linkend="gboolean">gboolean</link> *cancelflag,
 
194
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
195
<para>
 
196
 
 
197
</para><variablelist role="params">
 
198
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
199
<listitem><simpara>
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
 
202
<listitem><simpara>
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>cancelflag</parameter>&nbsp;:</term>
 
205
<listitem><simpara>
 
206
</simpara></listitem></varlistentry>
 
207
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
208
<listitem><simpara>
 
209
 
 
210
 
 
211
</simpara></listitem></varlistentry>
 
212
</variablelist></refsect2>
 
213
<refsect2>
 
214
<title><anchor id="rb-file-helpers-init"/>rb_file_helpers_init ()</title>
 
215
<indexterm><primary>rb_file_helpers_init</primary></indexterm><programlisting><link linkend="void">void</link>        rb_file_helpers_init            (void);</programlisting>
 
216
<para>
 
217
 
 
218
</para></refsect2>
 
219
<refsect2>
 
220
<title><anchor id="rb-file-helpers-shutdown"/>rb_file_helpers_shutdown ()</title>
 
221
<indexterm><primary>rb_file_helpers_shutdown</primary></indexterm><programlisting><link linkend="void">void</link>        rb_file_helpers_shutdown        (void);</programlisting>
 
222
<para>
 
223
 
 
224
</para></refsect2>
 
225
 
 
226
</refsect1>
 
227
 
 
228
 
 
229
 
 
230
 
 
231
</refentry>