<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedata-book-EDataBookFactory">
<refmeta>
<refentrytitle role="top_of_page" id="libedata-book-EDataBookFactory.top_of_page">EDataBookFactory</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATA-BOOK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EDataBookFactory</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="libedata-book-EDataBookFactory.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="EDataBookFactory">EDataBookFactory</link>;
<link linkend="EDataBookFactory">EDataBookFactory</link> *  <link linkend="e-data-book-factory-new">e_data_book_factory_new</link>             (void);
<link linkend="void">void</link>                <link linkend="e-data-book-factory-register-backend">e_data_book_factory_register_backend</link>
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
                                                         <link linkend="EBookBackendFactory">EBookBackendFactory</link> *backend_factory);
<link linkend="int">int</link>                 <link linkend="e-data-book-factory-get-n-backends">e_data_book_factory_get_n_backends</link>  (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);
<link linkend="void">void</link>                <link linkend="e-data-book-factory-register-backends">e_data_book_factory_register_backends</link>
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);
<link linkend="void">void</link>                <link linkend="e-data-book-factory-dump-active-backends">e_data_book_factory_dump_active_backends</link>
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);
<link linkend="gboolean">gboolean</link>            <link linkend="e-data-book-factory-activate">e_data_book_factory_activate</link>        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
                                                         const <link linkend="char">char</link> *iid);
<link linkend="void">void</link>                <link linkend="e-data-book-factory-set-backend-mode">e_data_book_factory_set_backend_mode</link>
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
                                                         <link linkend="int">int</link> mode);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libedata-book-EDataBookFactory.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libedata-book-EDataBookFactory.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EDataBookFactory" role="struct">
<title>EDataBookFactory</title>
<indexterm zone="EDataBookFactory"><primary sortas="EDataBookFactory">EDataBookFactory</primary></indexterm><programlisting>typedef struct {
	BonoboObject            parent_object;
	EDataBookFactoryPrivate *priv;
} EDataBookFactory;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="e-data-book-factory-new" role="function">
<title>e_data_book_factory_new ()</title>
<indexterm zone="e-data-book-factory-new"><primary sortas="e_data_book_factory_new">e_data_book_factory_new</primary></indexterm><programlisting><link linkend="EDataBookFactory">EDataBookFactory</link> *  e_data_book_factory_new             (void);</programlisting>
<para>
Create a new <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-book-factory-register-backend" role="function">
<title>e_data_book_factory_register_backend ()</title>
<indexterm zone="e-data-book-factory-register-backend"><primary sortas="e_data_book_factory_register_backend">e_data_book_factory_register_backend</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_register_backend
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
                                                         <link linkend="EBookBackendFactory">EBookBackendFactory</link> *backend_factory);</programlisting>
<para>
Registers <parameter>backend_factory</parameter> with <parameter>factory</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>backend_factory</parameter>&#160;:</term>
<listitem><simpara> an <link linkend="EBookBackendFactory"><type>EBookBackendFactory</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-book-factory-get-n-backends" role="function">
<title>e_data_book_factory_get_n_backends ()</title>
<indexterm zone="e-data-book-factory-get-n-backends"><primary sortas="e_data_book_factory_get_n_backends">e_data_book_factory_get_n_backends</primary></indexterm><programlisting><link linkend="int">int</link>                 e_data_book_factory_get_n_backends  (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);</programlisting>
<para>
Queries the number of running addressbook backends in an addressbook factory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> An addressbook factory.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Number of running backends.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-book-factory-register-backends" role="function">
<title>e_data_book_factory_register_backends ()</title>
<indexterm zone="e-data-book-factory-register-backends"><primary sortas="e_data_book_factory_register_backends">e_data_book_factory_register_backends</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_register_backends
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);</programlisting>
<para>
Register the backends supported by the Evolution Data Server,
with <parameter>book_factory</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-book-factory-dump-active-backends" role="function">
<title>e_data_book_factory_dump_active_backends ()</title>
<indexterm zone="e-data-book-factory-dump-active-backends"><primary sortas="e_data_book_factory_dump_active_backends">e_data_book_factory_dump_active_backends</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_dump_active_backends
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory);</programlisting>
<para>
Dump the list of active backends registered with <parameter>factory</parameter>
to stdout. This is a debugging function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-book-factory-activate" role="function">
<title>e_data_book_factory_activate ()</title>
<indexterm zone="e-data-book-factory-activate"><primary sortas="e_data_book_factory_activate">e_data_book_factory_activate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_data_book_factory_activate        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
                                                         const <link linkend="char">char</link> *iid);</programlisting>
<para>
Activates the factory specified by <parameter>iid</parameter>, using Bonobo.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iid</parameter>&#160;:</term>
<listitem><simpara> the OAF ID of the factory to activate
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for success, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-data-book-factory-set-backend-mode" role="function">
<title>e_data_book_factory_set_backend_mode ()</title>
<indexterm zone="e-data-book-factory-set-backend-mode"><primary sortas="e_data_book_factory_set_backend_mode">e_data_book_factory_set_backend_mode</primary></indexterm><programlisting><link linkend="void">void</link>                e_data_book_factory_set_backend_mode
                                                        (<link linkend="EDataBookFactory">EDataBookFactory</link> *factory,
                                                         <link linkend="int">int</link> mode);</programlisting>
<para>
Sets all the backends associated with <parameter>factory</parameter> to be either online
or offline. <parameter>mode</parameter> should be passed as 1 for offline, or 2 for
online.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara> an <link linkend="EDataBookFactory"><type>EDataBookFactory</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
<listitem><simpara> a connection status
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
