← Back to branch summary

~ubuntu-branches/ubuntu/breezy/evolution-data-server/breezy

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-account.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-10-10 11:30:56 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051010113056-rb4vj4kbs8yxft85
Tags: 1.4.1-0ubuntu3
* debian/patches/camel-imap-store.c.patch:
  - Ubuntu 17465: apply patch from
  http://bugzilla.gnome.org/attachment.cgi?id=53234&action=view
  (additional NULL pointer check)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/xml/e-account.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="libedataserver-EAccount">
 
5
<refmeta>
 
6
<refentrytitle id="top_of_page">EAccount</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>EAccount</refname>
 
13
<refpurpose></refpurpose>
 
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
15
</refnamediv>
 
16
 
 
17
<refsynopsisdiv id="synopsis">
 
18
<title id="synopsis.title">Synopsis</title>
 
19
 
 
20
<synopsis>
 
21
 
 
22
 
 
23
 
 
24
            <link linkend="EAccountIdentity">EAccountIdentity</link>;
 
25
            <link linkend="EAccountService">EAccountService</link>;
 
26
<link linkend="EAccount">EAccount</link>*   <link linkend="e-account-new">e_account_new</link>                   (void);
 
27
<link linkend="EAccount">EAccount</link>*   <link linkend="e-account-new-from-xml">e_account_new_from_xml</link>          (const <link linkend="char">char</link> *xml);
 
28
<link linkend="gboolean">gboolean</link>    <link linkend="e-account-set-from-xml">e_account_set_from_xml</link>          (<link linkend="EAccount">EAccount</link> *account,
 
29
                                             const <link linkend="char">char</link> *xml);
 
30
<link linkend="void">void</link>        <link linkend="e-account-import">e_account_import</link>                (<link linkend="EAccount">EAccount</link> *dest,
 
31
                                             <link linkend="EAccount">EAccount</link> *src);
 
32
<link linkend="char">char</link>*       <link linkend="e-account-to-xml">e_account_to_xml</link>                (<link linkend="EAccount">EAccount</link> *account);
 
33
<link linkend="char">char</link>*       <link linkend="e-account-uid-from-xml">e_account_uid_from_xml</link>          (const <link linkend="char">char</link> *xml);
 
34
 
 
35
</synopsis>
 
36
</refsynopsisdiv>
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
<refsect1 id="desc">
 
47
<title id="desc.title">Description</title>
 
48
<para>
 
49
 
 
50
</para>
 
51
</refsect1>
 
52
 
 
53
<refsect1 id="details">
 
54
<title id="details.title">Details</title>
 
55
<refsect2>
 
56
<title><anchor id="EAccountIdentity"/>EAccountIdentity</title>
 
57
<indexterm><primary>EAccountIdentity</primary></indexterm><programlisting>typedef struct {
 
58
        char *name;
 
59
        char *address;
 
60
        char *reply_to;
 
61
        char *organization;
 
62
        
 
63
        int def_signature;
 
64
        gboolean auto_signature;
 
65
} EAccountIdentity;
 
66
</programlisting>
 
67
<para>
 
68
 
 
69
</para></refsect2>
 
70
<refsect2>
 
71
<title><anchor id="EAccountService"/>EAccountService</title>
 
72
<indexterm><primary>EAccountService</primary></indexterm><programlisting>typedef struct {
 
73
        char *url;
 
74
        gboolean keep_on_server;
 
75
        gboolean auto_check;
 
76
        int auto_check_time;
 
77
        gboolean save_passwd;
 
78
} EAccountService;
 
79
</programlisting>
 
80
<para>
 
81
 
 
82
</para></refsect2>
 
83
<refsect2>
 
84
<title><anchor id="e-account-new"/>e_account_new ()</title>
 
85
<indexterm><primary>e_account_new</primary></indexterm><programlisting><link linkend="EAccount">EAccount</link>*   e_account_new                   (void);</programlisting>
 
86
<para>
 
87
</para>
 
88
<para>
 
89
 
 
90
</para><variablelist role="params">
 
91
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a blank new account which can be filled in and
 
92
added to an <link linkend="EAccountList"><type>EAccountList</type></link>.
 
93
</simpara></listitem></varlistentry>
 
94
</variablelist></refsect2>
 
95
<refsect2>
 
96
<title><anchor id="e-account-new-from-xml"/>e_account_new_from_xml ()</title>
 
97
<indexterm><primary>e_account_new_from_xml</primary></indexterm><programlisting><link linkend="EAccount">EAccount</link>*   e_account_new_from_xml          (const <link linkend="char">char</link> *xml);</programlisting>
 
98
<para>
 
99
</para>
 
100
<para>
 
101
 
 
102
</para><variablelist role="params">
 
103
<varlistentry><term><parameter>xml</parameter>&nbsp;:</term>
 
104
<listitem><simpara> an XML account description
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EAccount"><type>EAccount</type></link> based on the data in <parameter>xml</parameter>, or <literal>NULL</literal>
 
107
if <parameter>xml</parameter> could not be parsed as valid account data.
 
108
</simpara></listitem></varlistentry>
 
109
</variablelist></refsect2>
 
110
<refsect2>
 
111
<title><anchor id="e-account-set-from-xml"/>e_account_set_from_xml ()</title>
 
112
<indexterm><primary>e_account_set_from_xml</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_account_set_from_xml          (<link linkend="EAccount">EAccount</link> *account,
 
113
                                             const <link linkend="char">char</link> *xml);</programlisting>
 
114
<para>
 
115
Changes <parameter>account</parameter> to match <parameter>xml</parameter>.</para>
 
116
<para>
 
117
 
 
118
</para><variablelist role="params">
 
119
<varlistentry><term><parameter>account</parameter>&nbsp;:</term>
 
120
<listitem><simpara> an <link linkend="EAccount"><type>EAccount</type></link>
 
121
</simpara></listitem></varlistentry>
 
122
<varlistentry><term><parameter>xml</parameter>&nbsp;:</term>
 
123
<listitem><simpara> an XML account description.
 
124
</simpara></listitem></varlistentry>
 
125
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>account</parameter> was changed, <literal>FALSE</literal> if <parameter>account</parameter>
 
126
already matched <parameter>xml</parameter> or <parameter>xml</parameter> could not be parsed
 
127
</simpara></listitem></varlistentry>
 
128
</variablelist></refsect2>
 
129
<refsect2>
 
130
<title><anchor id="e-account-import"/>e_account_import ()</title>
 
131
<indexterm><primary>e_account_import</primary></indexterm><programlisting><link linkend="void">void</link>        e_account_import                (<link linkend="EAccount">EAccount</link> *dest,
 
132
                                             <link linkend="EAccount">EAccount</link> *src);</programlisting>
 
133
<para>
 
134
Import the settings from <parameter>src</parameter> to <parameter>dest</parameter>.</para>
 
135
<para>
 
136
 
 
137
</para><variablelist role="params">
 
138
<varlistentry><term><parameter>dest</parameter>&nbsp;:</term>
 
139
<listitem><simpara> destination account object
 
140
</simpara></listitem></varlistentry>
 
141
<varlistentry><term><parameter>src</parameter>&nbsp;:</term>
 
142
<listitem><simpara> source account object
 
143
</simpara></listitem></varlistentry>
 
144
</variablelist></refsect2>
 
145
<refsect2>
 
146
<title><anchor id="e-account-to-xml"/>e_account_to_xml ()</title>
 
147
<indexterm><primary>e_account_to_xml</primary></indexterm><programlisting><link linkend="char">char</link>*       e_account_to_xml                (<link linkend="EAccount">EAccount</link> *account);</programlisting>
 
148
<para>
 
149
</para>
 
150
<para>
 
151
 
 
152
</para><variablelist role="params">
 
153
<varlistentry><term><parameter>account</parameter>&nbsp;:</term>
 
154
<listitem><simpara> an <link linkend="EAccount"><type>EAccount</type></link>
 
155
</simpara></listitem></varlistentry>
 
156
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an XML representation of <parameter>account</parameter>, which the caller
 
157
must free.
 
158
</simpara></listitem></varlistentry>
 
159
</variablelist></refsect2>
 
160
<refsect2>
 
161
<title><anchor id="e-account-uid-from-xml"/>e_account_uid_from_xml ()</title>
 
162
<indexterm><primary>e_account_uid_from_xml</primary></indexterm><programlisting><link linkend="char">char</link>*       e_account_uid_from_xml          (const <link linkend="char">char</link> *xml);</programlisting>
 
163
<para>
 
164
</para>
 
165
<para>
 
166
 
 
167
</para><variablelist role="params">
 
168
<varlistentry><term><parameter>xml</parameter>&nbsp;:</term>
 
169
<listitem><simpara> an XML account description
 
170
</simpara></listitem></varlistentry>
 
171
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the permanent UID of the account described by <parameter>xml</parameter>
 
172
(or <literal>NULL</literal> if <parameter>xml</parameter> could not be parsed or did not contain a uid).
 
173
The caller must free this string.
 
174
</simpara></listitem></varlistentry>
 
175
</variablelist></refsect2>
 
176
 
 
177
</refsect1>
 
178
 
 
179
 
 
180
 
 
181
 
 
182
</refentry>