1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>File Utilities: libxfce4util Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libxfce4util Reference Manual">
<link rel="up" href="ch01.html" title="[Insert title here]">
<link rel="prev" href="libxfce4util-Unicode-Support-Functions.html" title="Unicode Manipulation">
<link rel="next" href="libxfce4util-GIO-Extensions.html" title="GIO Extensions">
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libxfce4util-File-Utilities.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libxfce4util-Unicode-Support-Functions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libxfce4util-GIO-Extensions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libxfce4util-File-Utilities"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4util-File-Utilities.top_of_page"></a>File Utilities</span></h2>
<p>File Utilities — miscellaneous file-related utility functions.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libxfce4util-File-Utilities.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libxfce4util-File-Utilities.html#xfce-mkdirhier" title="xfce_mkdirhier ()">xfce_mkdirhier</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libxfce4util-File-Utilities.html#xfce-create-shared-thumbnail-path" title="xfce_create_shared_thumbnail_path ()">xfce_create_shared_thumbnail_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libxfce4util-File-Utilities.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libxfce4util/libxfce4util.h>
</pre>
</div>
<div class="refsect1">
<a name="libxfce4util-File-Utilities.description"></a><h2>Description</h2>
<p>File Utilities</p>
</div>
<div class="refsect1">
<a name="libxfce4util-File-Utilities.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfce-mkdirhier"></a><h3>xfce_mkdirhier ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfce_mkdirhier (<em class="parameter"><code>const <span class="type">gchar</span> *whole_path</code></em>,
<em class="parameter"><code><span class="type">gulong</span> mode</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates the specified directory <em class="parameter"><code>whole_path</code></em>
, but unlike the <code class="function">mkdir()</code>
function from the standard C library, if any of the parent directories
of the <em class="parameter"><code>whole_path</code></em>
do not exists, they are created as well.</p>
<p>If the directory specified by <em class="parameter"><code>whole_path</code></em>
already exists, this function
performs no operation and simply returns <code class="literal">TRUE</code>.</p>
<div class="refsect3">
<a name="xfce-mkdirhier.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>whole_path</p></td>
<td class="parameter_description"><p>path to the directory to create.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>file permissions to use for the newly created directories.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location where to store GError object to, error are returned
in the <code class="literal">G_FILE_ERROR</code> domain.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-mkdirhier.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, else <code class="literal">FALSE</code>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-2.html#api-index-4.2">4.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-create-shared-thumbnail-path"></a><h3>xfce_create_shared_thumbnail_path ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
xfce_create_shared_thumbnail_path (<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *size</code></em>);</pre>
<p>Creates the shared thumbnail path for the file that corresponds to the given <em class="parameter"><code>uri</code></em>
and <em class="parameter"><code>size</code></em>
. No checks are made regarding the existence of the thumbnail.</p>
<p>It is the duty of the caller to free the returned string.</p>
<div class="refsect3">
<a name="xfce-create-shared-thumbnail-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>the uri of the file whose shared thumbnail we want to find.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the thumbnail size (e.g. normal, large).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-create-shared-thumbnail-path.returns"></a><h4>Returns</h4>
<p> a string with the thumbnail path or NULL if the <em class="parameter"><code>uri</code></em>
could not be converted to
a local filename.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-17-1.html#api-index-4.17.1">4.17.1</a></p>
</div>
</div>
<div class="refsect1">
<a name="libxfce4util-File-Utilities.see-also"></a><h2>See Also</h2>
<p>https://developer.gnome.org/glib/stable/glib-File-Utilities.html</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>
|
