/usr/share/gtk-doc/html/libinfinity-0.6/libinfinity-0.6-InfFileUtil.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 | <!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 and directory utility functions: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfCertificateChain.html" title="InfCertificateChain">
<link rel="next" href="libinfinity-0.6-InfCertUtil.html" title="Certificate utility functions">
<meta name="generator" content="GTK-Doc V1.24 (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="#libinfinity-0.6-InfFileUtil.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfCertificateChain.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libinfinity-0.6-InfCertUtil.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libinfinity-0.6-InfFileUtil"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinfinity-0.6-InfFileUtil.top_of_page"></a>File and directory utility functions</span></h2>
<p>File and directory utility functions — Helper functions to handle directories.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libinfinity-0.6-InfFileUtil.html#InfFileListFunc" title="InfFileListFunc ()">*InfFileListFunc</a><span class="c_punctuation">)</span> <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="libinfinity-0.6-InfFileUtil.html#inf-file-util-create-single-directory" title="inf_file_util_create_single_directory ()">inf_file_util_create_single_directory</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="libinfinity-0.6-InfFileUtil.html#inf-file-util-create-directory" title="inf_file_util_create_directory ()">inf_file_util_create_directory</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="libinfinity-0.6-InfFileUtil.html#inf-file-util-list-directory" title="inf_file_util_list_directory ()">inf_file_util_list_directory</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="libinfinity-0.6-InfFileUtil.html#inf-file-util-delete-file" title="inf_file_util_delete_file ()">inf_file_util_delete_file</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="libinfinity-0.6-InfFileUtil.html#inf-file-util-delete-single-directory" title="inf_file_util_delete_single_directory ()">inf_file_util_delete_single_directory</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="libinfinity-0.6-InfFileUtil.html#inf-file-util-delete-directory" title="inf_file_util_delete_directory ()">inf_file_util_delete_directory</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="libinfinity-0.6-InfFileUtil.html#inf-file-util-delete" title="inf_file_util_delete ()">inf_file_util_delete</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfFileUtil.html#InfFileType" title="enum InfFileType">InfFileType</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-file-util.h>
</pre>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.description"></a><h2>Description</h2>
<p>These functions are utility functions that can be used when dealing with
directories. It allows platform-independent creation, deletion and
traversal of directories, with proper error reporting.</p>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="InfFileListFunc"></a><h3>InfFileListFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*InfFileListFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><a class="link" href="libinfinity-0.6-InfFileUtil.html#InfFileType" title="enum InfFileType"><span class="type">InfFileType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This is the prototype of the callback function passed to
<a class="link" href="libinfinity-0.6-InfFileUtil.html#inf-file-util-list-directory" title="inf_file_util_list_directory ()"><code class="function">inf_file_util_list_directory()</code></a>. If the function returns <code class="literal">FALSE</code> then
directory traversal is stopped immediately. In addition <em class="parameter"><code>error</code></em>
can be set
and it is propagated to the caller of <a class="link" href="libinfinity-0.6-InfFileUtil.html#inf-file-util-list-directory" title="inf_file_util_list_directory ()"><code class="function">inf_file_util_list_directory()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.28.8.2.5"></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>name</p></td>
<td class="parameter_description"><p>The name of the current file.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>The full path to the current file.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The type of the current file.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data specified at the time of the call.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.2.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the iteration should be continued or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-create-single-directory"></a><h3>inf_file_util_create_single_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_create_single_directory (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">int</span> mode</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Attempts to create a directory at <em class="parameter"><code>path</code></em>
. The <em class="parameter"><code>mode</code></em>
parameter is only used
on Unix in which case it specifies the permissions to use for all newly
created directories in the same way as <code class="function">g_mkdir()</code> would.</p>
<div class="refsect3">
<a name="id-1.3.28.8.3.5"></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>path</p></td>
<td class="parameter_description"><p>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>Permissions to use for the newly created directory.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.3.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-create-directory"></a><h3>inf_file_util_create_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_create_directory (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">int</span> mode</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Attempts to create a directory at <em class="parameter"><code>path</code></em>
, creating intermediate directories
as necessary. The <em class="parameter"><code>mode</code></em>
parameter is only used on Unix in which case it
specifies the permissions to use for all newly created directories in the
same way as <code class="function">g_mkdir()</code> would.</p>
<div class="refsect3">
<a name="id-1.3.28.8.4.5"></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>path</p></td>
<td class="parameter_description"><p>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>Permissions to use for the newly created directory.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-list-directory"></a><h3>inf_file_util_list_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_list_directory (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><a class="link" href="libinfinity-0.6-InfFileUtil.html#InfFileListFunc" title="InfFileListFunc ()"><span class="type">InfFileListFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Calls <em class="parameter"><code>func</code></em>
for each file within the given directory. It also passes the
type of the found file to the callback function. The callback function can
return <code class="literal">FALSE</code> to stop the iteration. If it does this, then this function
still returns <code class="literal">TRUE</code>. This can for example be used to find a file in a
directory. If, in addition, the callback function sets <em class="parameter"><code>error</code></em>
, then this
function returns <code class="literal">FALSE</code> and propagates the error.</p>
<div class="refsect3">
<a name="id-1.3.28.8.5.5"></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>path</p></td>
<td class="parameter_description"><p>The directory to explore.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>Callback function to be called for each child of the directory at
<em class="parameter"><code>path</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data to pass to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.5.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-delete-file"></a><h3>inf_file_util_delete_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_delete_file (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Removes the file at <em class="parameter"><code>path</code></em>
if it is empty. Fails if <em class="parameter"><code>path</code></em>
points to a
directory and not a regular file. If the function fails <code class="literal">FALSE</code> is returned
and <em class="parameter"><code>error</code></em>
is set.</p>
<div class="refsect3">
<a name="id-1.3.28.8.6.5"></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>path</p></td>
<td class="parameter_description"><p>Path to the file to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.6.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-delete-single-directory"></a><h3>inf_file_util_delete_single_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_delete_single_directory (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Removes the directory at <em class="parameter"><code>path</code></em>
if it is empty, or fails otherwise. Fails
if <em class="parameter"><code>path</code></em>
points to a regular file and not a directory. If the function
fails <code class="literal">FALSE</code> is returned and <em class="parameter"><code>error</code></em>
is set.</p>
<div class="refsect3">
<a name="id-1.3.28.8.7.5"></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>path</p></td>
<td class="parameter_description"><p>Path to the directory to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.7.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-delete-directory"></a><h3>inf_file_util_delete_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_delete_directory (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Removes the directory at <em class="parameter"><code>path</code></em>
recursively. Fails if <em class="parameter"><code>path</code></em>
points to a
regular file and not a directory. If the function fails <code class="literal">FALSE</code> is returned
and <em class="parameter"><code>error</code></em>
is set.</p>
<div class="refsect3">
<a name="id-1.3.28.8.8.5"></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>path</p></td>
<td class="parameter_description"><p>Path to the directory to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.8.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-file-util-delete"></a><h3>inf_file_util_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_file_util_delete (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Removes the file or directory at <em class="parameter"><code>path</code></em>
. If it is a directory the directory
is deleted recursively. If the function fails <code class="literal">FALSE</code> is returned
and <em class="parameter"><code>error</code></em>
is set.</p>
<div class="refsect3">
<a name="id-1.3.28.8.9.5"></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>path</p></td>
<td class="parameter_description"><p>Path to the object to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.28.8.9.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfFileUtil.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfFileType"></a><h3>enum InfFileType</h3>
<p>This type represents the possible file types that
<a class="link" href="libinfinity-0.6-InfFileUtil.html#inf-file-util-list-directory" title="inf_file_util_list_directory ()"><code class="function">inf_file_util_list_directory()</code></a> can report.</p>
<div class="refsect3">
<a name="id-1.3.28.9.2.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INF-FILE-TYPE-UNKNOWN:CAPS"></a>INF_FILE_TYPE_UNKNOWN</p></td>
<td class="enum_member_description">
<p>Unknown file type.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-FILE-TYPE-REG:CAPS"></a>INF_FILE_TYPE_REG</p></td>
<td class="enum_member_description">
<p>File is a regular file.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-FILE-TYPE-DIR:CAPS"></a>INF_FILE_TYPE_DIR</p></td>
<td class="enum_member_description">
<p>File is a directory.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-FILE-TYPE-LNK:CAPS"></a>INF_FILE_TYPE_LNK</p></td>
<td class="enum_member_description">
<p>File is a symbolic link.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|