File: mimedir-attendee.sgml

package info (click to toggle)
libmimedir-gnome 0.3.1-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 4,732 kB
  • ctags: 1,283
  • sloc: ansic: 13,274; sh: 8,050; makefile: 211
file content (145 lines) | stat: -rw-r--r-- 6,695 bytes parent folder | download
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
<refentry id="mimedir-MIMEDirAttendee">
<refmeta>
<refentrytitle>MIMEDirAttendee</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>MIMEDIR Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>MIMEDirAttendee</refname><refpurpose>iCalendar attendee object</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>

#include &lt;mimedir/mimedir-attendee.h&gt;



            <link linkend="MIMEDirAttendee">MIMEDirAttendee</link>;

<link linkend="MIMEDirAttendee">MIMEDirAttendee</link>* <link linkend="mimedir-attendee-new">mimedir_attendee_new</link>       (void);
<link linkend="MIMEDirAttendee">MIMEDirAttendee</link>* <link linkend="mimedir-attendee-new-from-attribute">mimedir_attendee_new_from_attribute</link>
                                            (<link linkend="MIMEDirAttribute">MIMEDirAttribute</link> *attribute,
                                             <link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link>    <link linkend="mimedir-attendee-read-from-attribute">mimedir_attendee_read_from_attribute</link>
                                            (<link linkend="MIMEDirAttendee">MIMEDirAttendee</link> *attendee,
                                             <link linkend="MIMEDirAttribute">MIMEDirAttribute</link> *attribute,
                                             <link linkend="GError">GError</link> **error);
<link linkend="MIMEDirAttribute">MIMEDirAttribute</link>* <link linkend="mimedir-attendee-write-to-attribute">mimedir_attendee_write_to_attribute</link>
                                            (<link linkend="MIMEDirAttendee">MIMEDirAttendee</link> *attendee);


</synopsis>
</refsynopsisdiv>









<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="MIMEDirAttendee">MIMEDirAttendee</title>
<indexterm><primary>MIMEDirAttendee</primary></indexterm><programlisting>typedef struct {
	GObject parent;

	/* Read Only */

	gchar *uri;

	MIMEDirAttendeePriv *priv;
} MIMEDirAttendee;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="mimedir-attendee-new">mimedir_attendee_new ()</title>
<indexterm><primary>mimedir_attendee_new</primary></indexterm><programlisting><link linkend="MIMEDirAttendee">MIMEDirAttendee</link>* mimedir_attendee_new       (void);</programlisting>
<para>
Creates a new attendee object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new attendee object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="mimedir-attendee-new-from-attribute">mimedir_attendee_new_from_attribute ()</title>
<indexterm><primary>mimedir_attendee_new_from_attribute</primary></indexterm><programlisting><link linkend="MIMEDirAttendee">MIMEDirAttendee</link>* mimedir_attendee_new_from_attribute
                                            (<link linkend="MIMEDirAttribute">MIMEDirAttribute</link> *attribute,
                                             <link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new attendee object and initializes it with values read
from the supplied attribute object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>attribute</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="MIMEDirAttribute"><type>MIMEDirAttribute</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> error storage location or <literal>NULL</literal>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="MIMEDirAttendee"><type>MIMEDirAttendee</type></link> object or <literal>NULL</literal> on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="mimedir-attendee-read-from-attribute">mimedir_attendee_read_from_attribute ()</title>
<indexterm><primary>mimedir_attendee_read_from_attribute</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    mimedir_attendee_read_from_attribute
                                            (<link linkend="MIMEDirAttendee">MIMEDirAttendee</link> *attendee,
                                             <link linkend="MIMEDirAttribute">MIMEDirAttribute</link> *attribute,
                                             <link linkend="GError">GError</link> **error);</programlisting>
<para>
Initializes <parameter>attendee</parameter> with data read from <parameter>attribute</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>attendee</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="MIMEDirAttendee"><type>MIMEDirAttendee</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attribute</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="MIMEDirAttribute"><type>MIMEDirAttribute</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> error storage location or <literal>NULL</literal>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> success indicator
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="mimedir-attendee-write-to-attribute">mimedir_attendee_write_to_attribute ()</title>
<indexterm><primary>mimedir_attendee_write_to_attribute</primary></indexterm><programlisting><link linkend="MIMEDirAttribute">MIMEDirAttribute</link>* mimedir_attendee_write_to_attribute
                                            (<link linkend="MIMEDirAttendee">MIMEDirAttendee</link> *attendee);</programlisting>
<para>
Write <parameter>attendee</parameter> to a newly allocated <link linkend="MIMEDirAttribute"><type>MIMEDirAttribute</type></link> object. The
returned object should be freed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>attendee</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="MIMEDirAttendee"><type>MIMEDirAttendee</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly allocated <link linkend="MIMEDirAttribute"><type>MIMEDirAttribute</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>