/usr/share/gtk-doc/html/eds/eds-ESourceRegistryServer.html is in evolution-data-server-doc 3.18.5-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceRegistryServer: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch07.html" title="Registry Service Classes">
<link rel="prev" href="eds-EServerSideSource.html" title="EServerSideSource">
<link rel="next" href="ch08.html" title="Addressbook Backend Classes">
<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="#eds-ESourceRegistryServer.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="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-EServerSideSource.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch08.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-ESourceRegistryServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-ESourceRegistryServer.top_of_page"></a>ESourceRegistryServer</span></h2>
<p>ESourceRegistryServer — Server-side repository for data sources</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-ESourceRegistryServer.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">
<a class="link" href="eds-EDBusServer.html#EDBusServer" title="struct EDBusServer"><span class="returnvalue">EDBusServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-new" title="e_source_registry_server_new ()">e_source_registry_server_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-add-source" title="e_source_registry_server_add_source ()">e_source_registry_server_add_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-remove-source" title="e_source_registry_server_remove_source ()">e_source_registry_server_remove_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-load-directory" title="e_source_registry_server_load_directory ()">e_source_registry_server_load_directory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-load-resource" title="e_source_registry_server_load_resource ()">e_source_registry_server_load_resource</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-load-file" title="e_source_registry_server_load_file ()">e_source_registry_server_load_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-load-error" title="e_source_registry_server_load_error ()">e_source_registry_server_load_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-ref-source" title="e_source_registry_server_ref_source ()">e_source_registry_server_ref_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-list-sources" title="e_source_registry_server_list_sources ()">e_source_registry_server_list_sources</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-find-extension" title="e_source_registry_server_find_extension ()">e_source_registry_server_find_extension</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="returnvalue">ECollectionBackend</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-ref-backend" title="e_source_registry_server_ref_backend ()">e_source_registry_server_ref_backend</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="returnvalue">ECollectionBackendFactory</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-ref-backend-factory" title="e_source_registry_server_ref_backend_factory ()">e_source_registry_server_ref_backend_factory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-load-all" title="e_source_registry_server_load_all ()">e_source_registry_server_load_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ESourceCredentialsProvider</span> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-ref-credentials-provider" title="e_source_registry_server_ref_credentials_provider ()">e_source_registry_server_ref_credentials_provider</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceRegistryServer.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-ESourceRegistryServer.html#E-SOURCE-REGISTRY-SERVER-OBJECT-PATH:CAPS" title="E_SOURCE_REGISTRY_SERVER_OBJECT_PATH">E_SOURCE_REGISTRY_SERVER_OBJECT_PATH</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-ESourceRegistryServer.html#EDS-REGISTRY-MODULES:CAPS" title="EDS_REGISTRY_MODULES">EDS_REGISTRY_MODULES</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer">ESourceRegistryServer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServerClass" title="struct ESourceRegistryServerClass">ESourceRegistryServerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceRegistryServer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libebackend/libebackend.h>
</pre>
</div>
<div class="refsect1">
<a name="eds-ESourceRegistryServer.description"></a><h2>Description</h2>
<p>The <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> is the heart of the registry D-Bus service.
Acting as a global singleton store for all <a class="link" href="eds-EServerSideSource.html#EServerSideSource" title="struct EServerSideSource"><span class="type">EServerSideSource</span></a> instances,
its responsibilities include loading data source content from key files,
exporting data sources to clients over D-Bus, handling content change
requests from clients, and saving content changes back to key files.</p>
<p>It also hosts any number of built-in or 3rd party data source collection
backends, which coordinate with <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> to automatically
advertise available data sources on a remote server.</p>
</div>
<div class="refsect1">
<a name="eds-ESourceRegistryServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-registry-server-new"></a><h3>e_source_registry_server_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EDBusServer.html#EDBusServer" title="struct EDBusServer"><span class="returnvalue">EDBusServer</span></a> *
e_source_registry_server_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new instance of <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a>.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.2.5"></a><h4>Returns</h4>
<p> a new instance of <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-add-source"></a><h3>e_source_registry_server_add_source ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_registry_server_add_source (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>Adds <em class="parameter"><code>source</code></em>
to <em class="parameter"><code>server</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-remove-source"></a><h3>e_source_registry_server_remove_source ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_registry_server_remove_source
(<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>Removes <em class="parameter"><code>source</code></em>
and all of its descendants from <em class="parameter"><code>server</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-load-directory"></a><h3>e_source_registry_server_load_directory ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_registry_server_load_directory
(<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">ESourcePermissionFlags</span> flags</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>Loads data source key files in <em class="parameter"><code>path</code></em>
. Because multiple errors can
occur when loading multiple files, <em class="parameter"><code>error</code></em>
is only set if <em class="parameter"><code>path</code></em>
can
not be opened. If a key file fails to load, the error is broadcast
through the <span class="type">“load-error”</span> signal.</p>
<p>If the <span class="type">E_DBUS_LOAD_DIRECTORY_REMOVABLE</span> flag is given, then the <em class="parameter"><code>server</code></em>
will emit signals on the D-Bus interface when key files are created or
deleted in <em class="parameter"><code>path</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.5.6"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>the path to the directory to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>permission flags for files loaded from <em class="parameter"><code>path</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.5.7"></a><h4>Returns</h4>
<p> <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>path</code></em>
was successfully opened, but this
does not imply the key files were successfully loaded</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-load-resource"></a><h3>e_source_registry_server_load_resource ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_registry_server_load_resource
(<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GResource.html"><span class="type">GResource</span></a> *resource</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><span class="type">ESourcePermissionFlags</span> flags</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>Loads data source key files from <em class="parameter"><code>resource</code></em>
by enumerating the children
at <em class="parameter"><code>path</code></em>
and calling <a class="link" href="eds-ESourceRegistryServer.html#e-source-registry-server-load-file" title="e_source_registry_server_load_file ()"><code class="function">e_source_registry_server_load_file()</code></a> on each child.
Because multiple errors can occur when loading multiple files, <em class="parameter"><code>error</code></em>
is
only set if <em class="parameter"><code>path</code></em>
is invalid. If a key file fails to load, the error is
broadcast through the <span class="type">“load-error”</span> signal.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>resource</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GResource.html"><span class="type">GResource</span></a> containing data source key files</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>the path to the data source key files inside <em class="parameter"><code>resource</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>permission flags for files loaded from <em class="parameter"><code>path</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.6.6"></a><h4>Returns</h4>
<p> <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>path</code></em>
was successfully located, but this does not
imply the key files were successfully loaded</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-load-file"></a><h3>e_source_registry_server_load_file ()</h3>
<pre class="programlisting"><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
e_source_registry_server_load_file (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<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><span class="type">ESourcePermissionFlags</span> flags</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 an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> for a native key file and adds it to <em class="parameter"><code>server</code></em>
.
If an error occurs, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and sets <em class="parameter"><code>error</code></em>
.</p>
<p>The returned <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> is referenced for thread-safety. Unreference
the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.7.6"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>the data source key file to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>initial permission flags for the data source</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.7.7"></a><h4>Returns</h4>
<p> the newly-added <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-load-error"></a><h3>e_source_registry_server_load_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_registry_server_load_error (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<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>const <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
<p>Emits the <span class="type">“load-error”</span> signal.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.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>server</p></td>
<td class="parameter_description"><p>an <span class="type">EBusSourceServer</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> that failed to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> describing the load error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-ref-source"></a><h3>e_source_registry_server_ref_source ()</h3>
<pre class="programlisting"><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
e_source_registry_server_ref_source (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>Looks up an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> in <em class="parameter"><code>server</code></em>
by its unique identifier string.</p>
<p>The returned <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> is referenced for thread-safety and must be
unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.9.6"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>a unique identifier string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.9.7"></a><h4>Returns</h4>
<p> an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-list-sources"></a><h3>e_source_registry_server_list_sources ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
e_source_registry_server_list_sources (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *extension_name</code></em>);</pre>
<p>Returns a list of registered sources, sorted by display name. If
<em class="parameter"><code>extension_name</code></em>
is given, restrict the list to sources having that
extension name.</p>
<p>The sources returned in the list are referenced for thread-safety.
They must each be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished
with them. Free the returned <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> itself with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
<p>An easy way to free the list properly in one step is as follows:</p>
<div class="informalexample"><pre class="programlisting">
g_list_free_full (list, g_object_unref);
</pre></div>
<p></p>
<div class="refsect3">
<a name="id-1.4.3.6.7.10.9"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extension_name</p></td>
<td class="parameter_description"><p>an extension name, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.10.10"></a><h4>Returns</h4>
<p> a sorted list of sources</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-find-extension"></a><h3>e_source_registry_server_find_extension ()</h3>
<pre class="programlisting"><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
e_source_registry_server_find_extension
(<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *extension_name</code></em>);</pre>
<p>Examines <em class="parameter"><code>source</code></em>
and its ancestors and returns the "deepest" <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>
having an <a class="link" href="eds-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> with the given <em class="parameter"><code>extension_name</code></em>
. If neither
<em class="parameter"><code>source</code></em>
nor any of its ancestors have such an extension, the function
returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>This function is useful in cases when an <a class="link" href="eds-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> is meant to
apply to both the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> it belongs to and the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>'s descendants.</p>
<p>A common example is the <a class="link" href="eds-ESourceCollection.html#ESourceCollection" title="struct ESourceCollection"><span class="type">ESourceCollection</span></a> extension, where descendants
of an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> having an <a class="link" href="eds-ESourceCollection.html#ESourceCollection" title="struct ESourceCollection"><span class="type">ESourceCollection</span></a> extension are implied to be
members of that collection. In that example, this function can be used
to test whether <em class="parameter"><code>source</code></em>
is a member of a collection.</p>
<p>The returned <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> is referenced for thread-safety and must be
unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<p>Note the function returns the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> containing the <a class="link" href="eds-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a>
instead of the <a class="link" href="eds-ESourceExtension.html#ESourceExtension" title="struct ESourceExtension"><span class="type">ESourceExtension</span></a> itself because extension instances are
not to be referenced directly (see <a class="link" href="eds-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a>).</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.11.9"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extension_name</p></td>
<td class="parameter_description"><p>the extension name to find</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.11.10"></a><h4>Returns</h4>
<p> an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-ref-backend"></a><h3>e_source_registry_server_ref_backend ()</h3>
<pre class="programlisting"><a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="returnvalue">ECollectionBackend</span></a> *
e_source_registry_server_ref_backend (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>Returns the <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> associated with <em class="parameter"><code>source</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if
there is no <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> associated with <em class="parameter"><code>source</code></em>
.</p>
<p>An <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> is associated with an <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> if the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> has
an <a class="link" href="eds-ESourceCollection.html#ESourceCollection" title="struct ESourceCollection"><span class="type">ESourceCollection</span></a> extension, or if it is a hierarchical descendant of
another <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> which has an <a class="link" href="eds-ESourceCollection.html#ESourceCollection" title="struct ESourceCollection"><span class="type">ESourceCollection</span></a> extension.</p>
<p>The returned <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> is referenced for thread-safety.
Unreference the <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished
with it.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.12.7"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.12.8"></a><h4>Returns</h4>
<p> the <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> for <em class="parameter"><code>source</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-ref-backend-factory"></a><h3>e_source_registry_server_ref_backend_factory ()</h3>
<pre class="programlisting"><a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="returnvalue">ECollectionBackendFactory</span></a> *
e_source_registry_server_ref_backend_factory
(<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>Returns the <a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a> for <em class="parameter"><code>source</code></em>
, if available.
If <em class="parameter"><code>source</code></em>
does not have an <a class="link" href="eds-ESourceCollection.html#ESourceCollection" title="struct ESourceCollection"><span class="type">ESourceCollection</span></a> extension, or if the
<a class="link" href="eds-ESourceCollection.html#ESourceCollection" title="struct ESourceCollection"><span class="type">ESourceCollection</span></a> extension names a <span class="type">“backend-name”</span> for
which there is no corresponding <a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a>, the function
returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>The returned <a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a> is referenced for thread-safety.
Unreference the <a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a> with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when
finished with it.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.13.6"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.13.7"></a><h4>Returns</h4>
<p> the <a class="link" href="eds-ECollectionBackendFactory.html#ECollectionBackendFactory" title="struct ECollectionBackendFactory"><span class="type">ECollectionBackendFactory</span></a> for <em class="parameter"><code>source</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-load-all"></a><h3>e_source_registry_server_load_all ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_source_registry_server_load_all (<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</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>
<div class="warning">
<p><code class="literal">e_source_registry_server_load_all</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p>Instead, implement an equivalent function yourself.
It was a mistake to encode this much file location
policy directly into the library API.</p>
</div>
<p>Loads data source key files from standard system-wide and user-specific
locations. Because multiple errors can occur when loading multiple files,
<em class="parameter"><code>error</code></em>
is only set if a directory can not be opened. If a data source key
file fails to load, the error is broadcast through the
<span class="type">“load-error”</span> signal.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.14.7"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.14.8"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the standard directories were successfully opened,
but this does not imply the key files were successfully loaded</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-registry-server-ref-credentials-provider"></a><h3>e_source_registry_server_ref_credentials_provider ()</h3>
<pre class="programlisting"><span class="returnvalue">ESourceCredentialsProvider</span> *
e_source_registry_server_ref_credentials_provider
(<em class="parameter"><code><a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>);</pre>
<p>Returns a referenced <span class="type">ESourceRegistryCredentialsProvider</span>.</p>
<div class="refsect3">
<a name="id-1.4.3.6.7.15.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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceRegistryServer.html#ESourceRegistryServer" title="struct ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.3.6.7.15.6"></a><h4>Returns</h4>
<p> A referenced <span class="type">ESourceRegistryCredentialsProvider</span>. Unref it with
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>, when no longer needed.</p>
</div>
<p class="since">Since: 3.16</p>
</div>
</div>
<div class="refsect1">
<a name="eds-ESourceRegistryServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SOURCE-REGISTRY-SERVER-OBJECT-PATH:CAPS"></a><h3>E_SOURCE_REGISTRY_SERVER_OBJECT_PATH</h3>
<pre class="programlisting">#define E_SOURCE_REGISTRY_SERVER_OBJECT_PATH</pre>
<p>D-Bus object path of the data source server.</p>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="EDS-REGISTRY-MODULES:CAPS"></a><h3>EDS_REGISTRY_MODULES</h3>
<pre class="programlisting">#define EDS_REGISTRY_MODULES "EDS_REGISTRY_MODULES"
</pre>
<p>This environment variable configures where the registry
server loads it's backend modules from.</p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceRegistryServer"></a><h3>struct ESourceRegistryServer</h3>
<pre class="programlisting">struct ESourceRegistryServer {
EDataFactory parent;
ESourceRegistryServerPrivate *priv;
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceRegistryServerClass"></a><h3>struct ESourceRegistryServerClass</h3>
<pre class="programlisting">struct ESourceRegistryServerClass {
EDataFactoryClass parent_class;
/* Signals */
void (*load_error) (ESourceRegistryServer *server,
GFile *file,
const GError *error);
void (*files_loaded) (ESourceRegistryServer *server);
void (*source_added) (ESourceRegistryServer *server,
ESource *source);
void (*source_removed) (ESourceRegistryServer *server,
ESource *source);
gboolean (*tweak_key_file) (ESourceRegistryServer *server,
GKeyFile *key_file,
const gchar *uid);
/* Reserved slots. */
gpointer reserved[16];
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|