blob: 49e533ba7229214974585dd5a3f6ae5b67056b16 (
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
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
|
<refentry id="gmime-gmime-stream-mem" revision="2 Mar 2002">
<refmeta>
<refentrytitle>gmime-stream-mem</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gmime-stream-mem</refname><refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="GMIME-STREAM-MEM-TYPE-CAPS">GMIME_STREAM_MEM_TYPE</link>
#define <link linkend="GMIME-IS-STREAM-MEM-CAPS">GMIME_IS_STREAM_MEM</link> (stream)
#define <link linkend="GMIME-STREAM-MEM-CAPS">GMIME_STREAM_MEM</link> (stream)
<link linkend="GMimeStream">GMimeStream</link>* <link linkend="g-mime-stream-mem-new">g_mime_stream_mem_new</link> (void);
<link linkend="GMimeStream">GMimeStream</link>* <link linkend="g-mime-stream-mem-new-with-byte-array">g_mime_stream_mem_new_with_byte_array</link>
(<link linkend="GByteArray">GByteArray</link> *array);
<link linkend="GMimeStream">GMimeStream</link>* <link linkend="g-mime-stream-mem-new-with-buffer">g_mime_stream_mem_new_with_buffer</link>
(const char *buffer,
<link linkend="size-t">size_t</link> len);
void <link linkend="g-mime-stream-mem-set-byte-array">g_mime_stream_mem_set_byte_array</link>
(<link linkend="GMimeStreamMem">GMimeStreamMem</link> *mem,
<link linkend="GByteArray">GByteArray</link> *array);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMIME-STREAM-MEM-TYPE-CAPS">GMIME_STREAM_MEM_TYPE</title>
<programlisting>#define GMIME_STREAM_MEM_TYPE g_str_hash ("GMimeStreamMem")
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GMIME-IS-STREAM-MEM-CAPS">GMIME_IS_STREAM_MEM()</title>
<programlisting>#define GMIME_IS_STREAM_MEM(stream) (((GMimeStream *) stream)->type == GMIME_STREAM_MEM_TYPE)
</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>stream</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="GMIME-STREAM-MEM-CAPS">GMIME_STREAM_MEM()</title>
<programlisting>#define GMIME_STREAM_MEM(stream) ((GMimeStreamMem *) stream)
</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>stream</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-stream-mem-new">g_mime_stream_mem_new ()</title>
<programlisting><link linkend="GMimeStream">GMimeStream</link>* g_mime_stream_mem_new (void);</programlisting>
<para>
Creates a new GMimeStreamMem 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"><emphasis>Returns</emphasis> :</entry><entry>a new memory stream.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-stream-mem-new-with-byte-array">g_mime_stream_mem_new_with_byte_array ()</title>
<programlisting><link linkend="GMimeStream">GMimeStream</link>* g_mime_stream_mem_new_with_byte_array
(<link linkend="GByteArray">GByteArray</link> *array);</programlisting>
<para>
Creates a new GMimeStreamMem with data <parameter>array</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>array</parameter> :</entry>
<entry> source data
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new memory stream using <parameter>array</parameter>.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-stream-mem-new-with-buffer">g_mime_stream_mem_new_with_buffer ()</title>
<programlisting><link linkend="GMimeStream">GMimeStream</link>* g_mime_stream_mem_new_with_buffer
(const char *buffer,
<link linkend="size-t">size_t</link> len);</programlisting>
<para>
Creates a new GMimeStreamMem object and initializes the stream
contents with the first <parameter>len</parameter> bytes of <parameter>buffer</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>buffer</parameter> :</entry>
<entry> stream data
</entry></row>
<row><entry align="right"><parameter>len</parameter> :</entry>
<entry> data length
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new memory stream initialized with <parameter>buffer</parameter>.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-stream-mem-set-byte-array">g_mime_stream_mem_set_byte_array ()</title>
<programlisting>void g_mime_stream_mem_set_byte_array
(<link linkend="GMimeStreamMem">GMimeStreamMem</link> *mem,
<link linkend="GByteArray">GByteArray</link> *array);</programlisting>
<para>
Sets the byte array on the memory stream. Note: The memory stream
is not responsible for freeing the byte array.</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>mem</parameter> :</entry>
<entry> memory stream
</entry></row>
<row><entry align="right"><parameter>array</parameter> :</entry>
<entry> stream data
</entry></row>
</tbody></tgroup></informaltable></refsect2>
</refsect1>
</refentry>
|
