/usr/share/gtk-doc/html/rhythmbox/rhythmbox-rb-file-helpers.html is in rhythmbox-doc 2.96-0ubuntu4.1.
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 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>rb-file-helpers</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch02.html" title="Lib">
<link rel="prev" href="rhythmbox-rb-debug.html" title="rb-debug">
<link rel="next" href="rhythmbox-rb-builder-helpers.html" title="rb-builder-helpers">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="rhythmbox-rb-debug.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
<td><a accesskey="n" href="rhythmbox-rb-builder-helpers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#rhythmbox-rb-file-helpers.synopsis" class="shortcut">Top</a>
|
<a href="#rhythmbox-rb-file-helpers.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="rhythmbox-rb-file-helpers"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-rb-file-helpers.top_of_page"></a>rb-file-helpers</span></h2>
<p>rb-file-helpers — An assortment of file and URI helper functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="rhythmbox-rb-file-helpers.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">const <span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file" title="rb_file ()">rb_file</a> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-user-data-dir" title="rb_user_data_dir ()">rb_user_data_dir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-user-cache-dir" title="rb_user_cache_dir ()">rb_user_cache_dir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-music-dir" title="rb_music_dir ()">rb_music_dir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-find-user-data-file" title="rb_find_user_data_file ()">rb_find_user_data_file</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-find-user-cache-file" title="rb_find_user_cache_file ()">rb_find_user_cache_file</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-helpers-init" title="rb_file_helpers_init ()">rb_file_helpers_init</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> uninstalled</code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-helpers-shutdown" title="rb_file_helpers_shutdown ()">rb_file_helpers_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-resolve-symlink" title="rb_uri_resolve_symlink ()">rb_uri_resolve_symlink</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-directory" title="rb_uri_is_directory ()">rb_uri_is_directory</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-exists" title="rb_uri_exists ()">rb_uri_exists</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-readable" title="rb_uri_is_readable ()">rb_uri_is_readable</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-writable" title="rb_uri_is_writable ()">rb_uri_is_writable</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-local" title="rb_uri_is_local ()">rb_uri_is_local</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-is-hidden" title="rb_uri_is_hidden ()">rb_uri_is_hidden</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-could-be-podcast" title="rb_uri_could_be_podcast ()">rb_uri_could_be_podcast</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *is_opml</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-make-hidden" title="rb_uri_make_hidden ()">rb_uri_make_hidden</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-handle-recursively" title="rb_uri_handle_recursively ()">rb_uri_handle_recursively</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
<em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-handle-recursively-async" title="rb_uri_handle_recursively_async ()">rb_uri_handle_recursively_async</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
<em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> data_destroy</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-mkstemp" title="rb_uri_mkstemp ()">rb_uri_mkstemp</a> (<em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>,
<em class="parameter"><code><span class="type">char</span> **uri_ret</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> **stream</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-canonicalise-uri" title="rb_canonicalise_uri ()">rb_canonicalise_uri</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-append-path" title="rb_uri_append_path ()">rb_uri_append_path</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-append-uri" title="rb_uri_append_uri ()">rb_uri_append_uri</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fragment</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-dir-name" title="rb_uri_get_dir_name ()">rb_uri_get_dir_name</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-short-path-name" title="rb_uri_get_short_path_name ()">rb_uri_get_short_path_name</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-check-dir-has-space" title="rb_check_dir_has_space ()">rb_check_dir_has_space</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *dir</code></em>,
<em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-check-dir-has-space-uri" title="rb_check_dir_has_space_uri ()">rb_check_dir_has_space_uri</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-mount-point" title="rb_uri_get_mount_point ()">rb_uri_get_mount_point</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-create-parent-dirs" title="rb_uri_create_parent_dirs ()">rb_uri_create_parent_dirs</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-file-find-extant-parent" title="rb_file_find_extant_parent ()">rb_file_find_extant_parent</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *file</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-uri-get-filesystem-type" title="rb_uri_get_filesystem_type ()">rb_uri_get_filesystem_type</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><span class="type">char</span> **mount_point</code></em>);
<span class="returnvalue">void</span> <a class="link" href="rhythmbox-rb-file-helpers.html#rb-sanitize-path-for-msdos-filesystem" title="rb_sanitize_path_for_msdos_filesystem ()">rb_sanitize_path_for_msdos_filesystem</a>
(<em class="parameter"><code><span class="type">char</span> *path</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="rhythmbox-rb-file-helpers.html#rb-sanitize-uri-for-filesystem" title="rb_sanitize_uri_for_filesystem ()">rb_sanitize_uri_for_filesystem</a> (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()">*RBUriRecurseFunc</a>) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-file-helpers.description"></a><h2>Description</h2>
<p>
This is a variety of functions for dealing with files and URIs, including
locating installed files, finding user cache and config directories,
and dealing with file naming restrictions for various filesystems.
</p>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-file-helpers.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="rb-file"></a><h3>rb_file ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * rb_file (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<p>
Searches for an installed file, returning the full path name
if found, NULL otherwise.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of file to search for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Full file name, if found. Must not be freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-user-data-dir"></a><h3>rb_user_data_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * rb_user_data_dir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This will create the rhythmbox user data directory, using the XDG Base
Directory specification. If none of the XDG environment variables are
set, this will be ~/.local/share/rhythmbox.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>string holding the path to the rhythmbox user data directory, or
NULL if the directory does not exist and cannot be created.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-user-cache-dir"></a><h3>rb_user_cache_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * rb_user_cache_dir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This will create the rhythmbox user cache directory, using the XDG
Base Directory specification. If none of the XDG environment
variables are set, this will be ~/.cache/rhythmbox.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>string holding the path to the rhythmbox user cache directory, or
NULL if the directory does not exist and could not be created.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-music-dir"></a><h3>rb_music_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * rb_music_dir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the default directory for the user's music library.
This will usually be the 'Music' directory under the home directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>user's music directory. must not be freed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-find-user-data-file"></a><h3>rb_find_user_data_file ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_find_user_data_file (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Determines the full path to use for user-specific files, such as rhythmdb.xml,
within the user data directory (see <em class="parameter"><code>rb_user_data_dir</code></em>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of file to find</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>allocated string containing the location of the file to use, even if
an error occurred.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-find-user-cache-file"></a><h3>rb_find_user_cache_file ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_find_user_cache_file (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Determines the full path to use for user-specific cached files
within the user cache directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of file to find</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>allocated string containing the location of the file to use, even if
an error occurred.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-file-helpers-init"></a><h3>rb_file_helpers_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_file_helpers_init (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> uninstalled</code></em>);</pre>
<p>
Sets up file search paths for <em class="parameter"><code>rb_file</code></em>. Must be called on startup.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>uninstalled</code></em> :</span></p></td>
<td>if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, search in source and build directories
as well as installed locations</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-file-helpers-shutdown"></a><h3>rb_file_helpers_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_file_helpers_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Frees various data allocated by file helper functions.
Should be called on shutdown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-resolve-symlink"></a><h3>rb_uri_resolve_symlink ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_resolve_symlink (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Attempts to resolve symlinks in <em class="parameter"><code>uri</code></em> and return a canonical URI for the file
it identifies.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI to process</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>returns error information</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>resolved URI, or NULL on error</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-is-directory"></a><h3>rb_uri_is_directory ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_is_directory (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>uri</code></em> identifies a directory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is a directory</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-exists"></a><h3>rb_uri_exists ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_exists (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Checks if a URI identifies a resource that exists
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> exists</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-is-readable"></a><h3>rb_uri_is_readable ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_is_readable (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Checks if the user can read the resource identified by <em class="parameter"><code>uri</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is readable</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-is-writable"></a><h3>rb_uri_is_writable ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_is_writable (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Checks if the user can write to the resource identified by <em class="parameter"><code>uri</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is writable</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-is-local"></a><h3>rb_uri_is_local ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_is_local (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>uri</code></em> identifies a local resource. Currently this just
checks that it uses the 'file' URI scheme.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is local</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-is-hidden"></a><h3>rb_uri_is_hidden ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_is_hidden (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>uri</code></em> is hidden, according to the Unix filename convention.
If the filename component of <em class="parameter"><code>uri</code></em> begins with a dot, the file is considered
hidden.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> is hidden</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-could-be-podcast"></a><h3>rb_uri_could_be_podcast ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_could_be_podcast (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *is_opml</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>uri</code></em> identifies a resource that is probably a podcast
(RSS or Atom feed). This does not perform any IO, it just guesses
based on the URI itself.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_opml</code></em> :</span></p></td>
<td>returns whether the URI identifies an OPML document</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uri</code></em> may be a podcast</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-make-hidden"></a><h3>rb_uri_make_hidden ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_make_hidden (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Constructs a URI that is similar to <em class="parameter"><code>uri</code></em> but which identifies
a hidden file. This can be used for temporary files that should not
be visible to the user while they are in use.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to construct a hidden version of</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>hidden URI, must be freed by the caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-handle-recursively"></a><h3>rb_uri_handle_recursively ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_uri_handle_recursively (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
<em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for each file found under the directory identified by <em class="parameter"><code>uri</code></em>.
If <em class="parameter"><code>uri</code></em> identifies a file, calls <em class="parameter"><code>func</code></em> for that instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>URI to visit</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancel</code></em> :</span></p></td>
<td>an optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> to allow cancellation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>Callback function. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Data for callback function</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-handle-recursively-async"></a><h3>rb_uri_handle_recursively_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_uri_handle_recursively_async (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancel</code></em>,
<em class="parameter"><code><a class="link" href="rhythmbox-rb-file-helpers.html#RBUriRecurseFunc" title="RBUriRecurseFunc ()"><span class="type">RBUriRecurseFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> data_destroy</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for each file found under the directory identified
by <em class="parameter"><code>uri</code></em>, or if <em class="parameter"><code>uri</code></em> identifies a file, calls it once
with that.
</p>
<p>
Directory recursion happens on a separate thread, but the callbacks
are called on the main thread.
</p>
<p>
If non-NULL, <em class="parameter"><code>destroy_data</code></em> will be called once all files have been
processed, or when the operation is cancelled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI to visit</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancel</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> to allow cancellation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>callback function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_destroy</code></em> :</span></p></td>
<td>function to call to free <em class="parameter"><code>user_data</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-mkstemp"></a><h3>rb_uri_mkstemp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_mkstemp (<em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>,
<em class="parameter"><code><span class="type">char</span> **uri_ret</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> **stream</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates a temporary file whose URI begins with <em class="parameter"><code>prefix</code></em>, returning
the file URI and an output stream for writing to it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>URI prefix</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri_ret</code></em> :</span></p></td>
<td>returns the temporary file URI</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>returns a <em class="parameter"><code>GOutputStream</code></em> for the temporary file</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>returns error information</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-canonicalise-uri"></a><h3>rb_canonicalise_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_canonicalise_uri (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Converts <em class="parameter"><code>uri</code></em> to canonical URI form, ensuring it doesn't contain
any redundant directory fragments or unnecessarily escaped characters.
All URIs passed to <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> functions should be canonicalised.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>URI to canonicalise</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>canonical URI, must be freed by caller</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-append-path"></a><h3>rb_uri_append_path ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_append_path (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<p>
Creates a new URI consisting of <em class="parameter"><code>path</code></em> appended to <em class="parameter"><code>uri</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI to append to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the path fragment to append</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new URI, must be freed by caller</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-append-uri"></a><h3>rb_uri_append_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_append_uri (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fragment</code></em>);</pre>
<p>
Creates a new URI consisting of <em class="parameter"><code>fragment</code></em> appended to <em class="parameter"><code>uri</code></em>.
Generally isn't a good idea.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the URI to append to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fragment</code></em> :</span></p></td>
<td>the URI fragment to append</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new URI, must be freed by caller</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-get-dir-name"></a><h3>rb_uri_get_dir_name ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_get_dir_name (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Returns the directory component of <em class="parameter"><code>uri</code></em>, that is, everything up
to the start of the filename.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new URI for parent of <em class="parameter"><code>uri</code></em>, must be freed by caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-get-short-path-name"></a><h3>rb_uri_get_short_path_name ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_get_short_path_name (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Returns the filename component of <em class="parameter"><code>uri</code></em>, that is, everything after the
final slash and before the start of the query string or fragment.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>filename component of <em class="parameter"><code>uri</code></em>, must be freed by caller</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-check-dir-has-space"></a><h3>rb_check_dir_has_space ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_check_dir_has_space (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *dir</code></em>,
<em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);</pre>
<p>
Checks that the filesystem holding <em class="parameter"><code>file</code></em> has at least <em class="parameter"><code>bytes_needed</code></em>
bytes available.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> to check</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bytes_needed</code></em> :</span></p></td>
<td>number of bytes to check for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if enough space is available.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-check-dir-has-space-uri"></a><h3>rb_check_dir_has_space_uri ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_check_dir_has_space_uri (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><span class="type">guint64</span> bytes_needed</code></em>);</pre>
<p>
Checks that the filesystem holding <em class="parameter"><code>uri</code></em> has at least <em class="parameter"><code>bytes_needed</code></em>
bytes available.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to check</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bytes_needed</code></em> :</span></p></td>
<td>number of bytes to check for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if enough space is available.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-get-mount-point"></a><h3>rb_uri_get_mount_point ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_get_mount_point (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Returns the mount point of the filesystem holding <em class="parameter"><code>uri</code></em>.
If <em class="parameter"><code>uri</code></em> is on a normal filesystem mount (such as /, /home,
/var, etc.) this will be NULL.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>filesystem mount point (must be freed by caller)
or NULL.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-create-parent-dirs"></a><h3>rb_uri_create_parent_dirs ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rb_uri_create_parent_dirs (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Ensures that all parent directories of <em class="parameter"><code>uri</code></em> exist so that
<em class="parameter"><code>uri</code></em> itself can be created directly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI for which to create parent directories</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>returns error information</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-file-find-extant-parent"></a><h3>rb_file_find_extant_parent ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> * rb_file_find_extant_parent (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *file</code></em>);</pre>
<p>
Walks up the filesystem hierarchy to find a <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> representing
the nearest extant ancestor of the specified file, which may be
the file itself if it exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> to find an extant ancestor of</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> for the nearest extant ancestor. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-uri-get-filesystem-type"></a><h3>rb_uri_get_filesystem_type ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_uri_get_filesystem_type (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><span class="type">char</span> **mount_point</code></em>);</pre>
<p>
Returns a string describing the type of the filesystem containing <em class="parameter"><code>uri</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>URI to get filesystem type for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mount_point</code></em> :</span></p></td>
<td>optionally returns the mount point for the filesystem as a URI</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>filesystem type string, must be freed by caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-sanitize-path-for-msdos-filesystem"></a><h3>rb_sanitize_path_for_msdos_filesystem ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rb_sanitize_path_for_msdos_filesystem
(<em class="parameter"><code><span class="type">char</span> *path</code></em>);</pre>
<p>
Modifies <em class="parameter"><code>path</code></em> such that it represents a legal path for MS DOS
filesystems.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>a path to sanitize (modified in place)</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rb-sanitize-uri-for-filesystem"></a><h3>rb_sanitize_uri_for_filesystem ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * rb_sanitize_uri_for_filesystem (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);</pre>
<p>
Removes characters from <em class="parameter"><code>uri</code></em> that are not allowed by the filesystem
on which it would be stored. At present, this only supports MS DOS
filesystems.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a URI to sanitize</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>sanitized copy of <em class="parameter"><code>uri</code></em>, must be freed by caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="RBUriRecurseFunc"></a><h3>RBUriRecurseFunc ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*RBUriRecurseFunc) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|