summaryrefslogtreecommitdiff
path: root/doc/sgml/gmime-object.sgml
blob: e008b0e63aea0f6a885d737cbc5419f6126d5119 (plain)
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
<refentry id="gmime-gmime-object">
<refmeta>
<refentrytitle>gmime-object</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gmime-object</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>



#define     <link linkend="GMIME-OBJECT-CAPS">GMIME_OBJECT</link>                    (object)
struct      <link linkend="GMimeObject">GMimeObject</link>;
void        <link linkend="g-mime-object-construct">g_mime_object_construct</link>         (<link linkend="GMimeObject">GMimeObject</link> *object,
                                             <link linkend="GMimeObject">GMimeObject</link> *object_template,
                                             unsigned int type);
void        <link linkend="g-mime-object-ref">g_mime_object_ref</link>               (<link linkend="GMimeObject">GMimeObject</link> *object);
void        <link linkend="g-mime-object-unref">g_mime_object_unref</link>             (<link linkend="GMimeObject">GMimeObject</link> *object);
</synopsis>
</refsynopsisdiv>





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

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMIME-OBJECT-CAPS">GMIME_OBJECT()</title>
<programlisting>#define GMIME_OBJECT(object) ((GMimeObject *) object)
</programlisting>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>object</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="GMimeObject">struct GMimeObject</title>
<programlisting>struct GMimeObject {
	unsigned int type;
	int refcount;
	
	void (*destroy) (GMimeObject *object);
};
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="g-mime-object-construct">g_mime_object_construct ()</title>
<programlisting>void        g_mime_object_construct         (<link linkend="GMimeObject">GMimeObject</link> *object,
                                             <link linkend="GMimeObject">GMimeObject</link> *object_template,
                                             unsigned int type);</programlisting>
<para>
Initializes a new object of type <parameter>type</parameter>, using the virtual methods
from <parameter>object_template</parameter>.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>object</parameter>&nbsp;:</entry>
<entry> object
</entry></row>
<row><entry align="right"><parameter>object_template</parameter>&nbsp;:</entry>
<entry> object template
</entry></row>
<row><entry align="right"><parameter>type</parameter>&nbsp;:</entry>
<entry> object type
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-object-ref">g_mime_object_ref ()</title>
<programlisting>void        g_mime_object_ref               (<link linkend="GMimeObject">GMimeObject</link> *object);</programlisting>
<para>
Ref's an object.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>object</parameter>&nbsp;:</entry>
<entry> object
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-object-unref">g_mime_object_unref ()</title>
<programlisting>void        g_mime_object_unref             (<link linkend="GMimeObject">GMimeObject</link> *object);</programlisting>
<para>
Unref's an object.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>object</parameter>&nbsp;:</entry>
<entry> object
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>