File: libxfce4util-GIO-Extensions.html

package info (click to toggle)
libxfce4util 4.20.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,568 kB
  • sloc: ansic: 5,483; sh: 5,064; makefile: 229; python: 128; sed: 16
file content (270 lines) | stat: -rw-r--r-- 13,599 bytes parent folder | download
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIO Extensions: 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-File-Utilities.html" title="File Utilities">
<link rel="next" href="libxfce4util-Xfce-String-Functions.html" title="Xfce Cstring/GString Functions">
<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-GIO-Extensions.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-File-Utilities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libxfce4util-Xfce-String-Functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libxfce4util-GIO-Extensions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4util-GIO-Extensions.top_of_page"></a>GIO Extensions</span></h2>
<p>GIO Extensions — various extensions to GIO</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libxfce4util-GIO-Extensions.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-GIO-Extensions.html#xfce-g-file-metadata-is-supported" title="xfce_g_file_metadata_is_supported ()">xfce_g_file_metadata_is_supported</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-GIO-Extensions.html#xfce-g-file-create-checksum" title="xfce_g_file_create_checksum ()">xfce_g_file_create_checksum</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libxfce4util-GIO-Extensions.html#xfce-g-file-set-trusted" title="xfce_g_file_set_trusted ()">xfce_g_file_set_trusted</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libxfce4util-GIO-Extensions.html#xfce-g-file-is-trusted" title="xfce_g_file_is_trusted ()">xfce_g_file_is_trusted</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libxfce4util-GIO-Extensions.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libxfce4util/libxfce4util.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libxfce4util-GIO-Extensions.description"></a><h2>Description</h2>
<p>Common used functions for I/O that are not provided by the Glib library</p>
</div>
<div class="refsect1">
<a name="libxfce4util-GIO-Extensions.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfce-g-file-metadata-is-supported"></a><h3>xfce_g_file_metadata_is_supported ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfce_g_file_metadata_is_supported (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>);</pre>
<p>Checks if GVFS-metadata is available for
the <em class="parameter"><code>file</code></em>
 provided.</p>
<div class="refsect3">
<a name="xfce-g-file-metadata-is-supported.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>file</p></td>
<td class="parameter_description"><p>a <span class="type">GFile</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-g-file-metadata-is-supported.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> is GVFS-metadata is supported, <code class="literal">FALSE</code> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-17.html#api-index-4.17">4.17</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-g-file-create-checksum"></a><h3>xfce_g_file_create_checksum ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
xfce_g_file_create_checksum (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
                             <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                             <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Generates an SHA-256 hash of the <em class="parameter"><code>file</code></em>
.</p>
<div class="refsect3">
<a name="xfce-g-file-create-checksum.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>file</p></td>
<td class="parameter_description"><p>a <span class="type">GFile</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-g-file-create-checksum.returns"></a><h4>Returns</h4>
<p>Checksum of the <em class="parameter"><code>file</code></em>
.
If file read fails, returns <code class="literal">NULL</code>. Free with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-17.html#api-index-4.17">4.17</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-g-file-set-trusted"></a><h3>xfce_g_file_set_trusted ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfce_g_file_set_trusted (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
                         <em class="parameter"><code><span class="type">gboolean</span> is_trusted</code></em>,
                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Sets the "safety flag" on if <em class="parameter"><code>is_trusted</code></em>
.</p>
<p>Safety flag is a new concept introduced in
XFCE 4.17. It is basically an additional
execution flag stored in GVFS-metadata.
Unlike the execution flag (+x), it is safe
to assume that this flag did not come from
foreign location (for example, by downloading
an tar archive) and is set by user.</p>
<p>The checksum of the file is stored, and
would be considered "on" only if checksum
matches with the file on execution.</p>
<div class="refsect3">
<a name="xfce-g-file-set-trusted.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>file</p></td>
<td class="parameter_description"><p>a <span class="type">GFile</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>is_trusted</p></td>
<td class="parameter_description"><p><span class="type">TRUE</span> if trusted, <span class="type">FALSE</span> if not</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-g-file-set-trusted.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-17.html#api-index-4.17">4.17</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-g-file-is-trusted"></a><h3>xfce_g_file_is_trusted ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfce_g_file_is_trusted (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
                        <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                        <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Compares the checksum stored in safety flag
with the actual file. If it matches, it
is considered safe.</p>
<p>Read the documentation of
<a class="link" href="libxfce4util-GIO-Extensions.html#xfce-g-file-set-trusted" title="xfce_g_file_set_trusted ()"><code class="function">xfce_g_file_set_trusted()</code></a> for details.</p>
<div class="refsect3">
<a name="xfce-g-file-is-trusted.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>file</p></td>
<td class="parameter_description"><p>a <span class="type">GFile</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-g-file-is-trusted.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if safety flag is verified
or not supported. <code class="literal">FALSE</code> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-17.html#api-index-4.17">4.17</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>