← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-stream-mem.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-stream-mem.xml
1
 
<refentry id="camel-CamelStreamMem">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelStreamMem.top_of_page">CamelStreamMem</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelStreamMem</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelStreamMem.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
struct              <link linkend="CamelStreamMem">CamelStreamMem</link>;
18
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-stream-mem-new">camel_stream_mem_new</link>                (void);
19
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-stream-mem-new-with-byte-array">camel_stream_mem_new_with_byte_array</link>
20
 
                                                        (<link linkend="GByteArray">GByteArray</link> *buffer);
21
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-stream-mem-new-with-buffer">camel_stream_mem_new_with_buffer</link>    (const <link linkend="gchar">gchar</link> *buffer,
22
 
                                                         <link linkend="gsize">gsize</link> len);
23
 
<link linkend="void">void</link>                <link linkend="camel-stream-mem-set-secure">camel_stream_mem_set_secure</link>         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem);
24
 
<link linkend="void">void</link>                <link linkend="camel-stream-mem-set-byte-array">camel_stream_mem_set_byte_array</link>     (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
25
 
                                                         <link linkend="GByteArray">GByteArray</link> *buffer);
26
 
<link linkend="void">void</link>                <link linkend="camel-stream-mem-set-buffer">camel_stream_mem_set_buffer</link>         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
27
 
                                                         const <link linkend="gchar">gchar</link> *buffer,
28
 
                                                         <link linkend="gsize">gsize</link> len);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
<refsect1 id="camel-CamelStreamMem.description" role="desc">
41
 
<title role="desc.title">Description</title>
42
 
<para>
43
 
</para>
44
 
</refsect1>
45
 
 
46
 
<refsect1 id="camel-CamelStreamMem.details" role="details">
47
 
<title role="details.title">Details</title>
48
 
<refsect2 id="CamelStreamMem" role="struct">
49
 
<title>struct CamelStreamMem</title>
50
 
<indexterm zone="CamelStreamMem"><primary sortas="CamelStreamMem">CamelStreamMem</primary></indexterm><programlisting>struct CamelStreamMem {
51
 
        CamelSeekableStream parent_object;
52
 
 
53
 
        guint owner:1;  /* do we own the buffer? */
54
 
        guint secure:1; /* do we clear the buffer on finalise (if we own it) */
55
 
        GByteArray *buffer;
56
 
};
57
 
</programlisting>
58
 
<para>
59
 
</para></refsect2>
60
 
<refsect2 id="camel-stream-mem-new" role="function">
61
 
<title>camel_stream_mem_new ()</title>
62
 
<indexterm zone="camel-stream-mem-new"><primary sortas="camel_stream_mem_new">camel_stream_mem_new</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link> *       camel_stream_mem_new                (void);</programlisting>
63
 
<para>
64
 
Create a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object.</para>
65
 
<para>
66
 
</para><variablelist role="params">
67
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
68
 
</simpara></listitem></varlistentry>
69
 
</variablelist></refsect2>
70
 
<refsect2 id="camel-stream-mem-new-with-byte-array" role="function">
71
 
<title>camel_stream_mem_new_with_byte_array ()</title>
72
 
<indexterm zone="camel-stream-mem-new-with-byte-array"><primary sortas="camel_stream_mem_new_with_byte_array">camel_stream_mem_new_with_byte_array</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link> *       camel_stream_mem_new_with_byte_array
73
 
                                                        (<link linkend="GByteArray">GByteArray</link> *buffer);</programlisting>
74
 
<para>
75
 
Create a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> using <parameter>buffer</parameter> as the stream data.
76
 
</para>
77
 
<para>
78
 
Note: The newly created <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> will destroy <parameter>buffer</parameter>
79
 
when destroyed.</para>
80
 
<para>
81
 
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
83
 
<listitem><simpara> a <link linkend="GByteArray"><type>GByteArray</type></link> to use as the stream data
84
 
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
86
 
</simpara></listitem></varlistentry>
87
 
</variablelist></refsect2>
88
 
<refsect2 id="camel-stream-mem-new-with-buffer" role="function">
89
 
<title>camel_stream_mem_new_with_buffer ()</title>
90
 
<indexterm zone="camel-stream-mem-new-with-buffer"><primary sortas="camel_stream_mem_new_with_buffer">camel_stream_mem_new_with_buffer</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link> *       camel_stream_mem_new_with_buffer    (const <link linkend="gchar">gchar</link> *buffer,
91
 
                                                         <link linkend="gsize">gsize</link> len);</programlisting>
92
 
<para>
93
 
Create a new memory stream using <parameter>buffer</parameter> as the stream data.
94
 
</para>
95
 
<para>
96
 
Note: <parameter>buffer</parameter> will be copied into an internal <link linkend="GByteArray"><type>GByteArray</type></link> structure
97
 
for use as the stream backing. This may have resource implications
98
 
you may wish to consider.</para>
99
 
<para>
100
 
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
102
 
<listitem><simpara> a memory buffer to use as the stream data
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
105
 
<listitem><simpara> length of <parameter>buffer</parameter>
106
 
</simpara></listitem></varlistentry>
107
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>
108
 
</simpara></listitem></varlistentry>
109
 
</variablelist></refsect2>
110
 
<refsect2 id="camel-stream-mem-set-secure" role="function">
111
 
<title>camel_stream_mem_set_secure ()</title>
112
 
<indexterm zone="camel-stream-mem-set-secure"><primary sortas="camel_stream_mem_set_secure">camel_stream_mem_set_secure</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_mem_set_secure         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem);</programlisting>
113
 
<para>
114
 
Mark the memory stream as secure.  At the very least this means the
115
 
data in the buffer will be cleared when the buffer is finalised.
116
 
This only applies to buffers owned by the stream.</para>
117
 
<para>
118
 
</para><variablelist role="params">
119
 
<varlistentry><term><parameter>mem</parameter>&#160;:</term>
120
 
<listitem><simpara> a <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object
121
 
</simpara></listitem></varlistentry>
122
 
</variablelist></refsect2>
123
 
<refsect2 id="camel-stream-mem-set-byte-array" role="function">
124
 
<title>camel_stream_mem_set_byte_array ()</title>
125
 
<indexterm zone="camel-stream-mem-set-byte-array"><primary sortas="camel_stream_mem_set_byte_array">camel_stream_mem_set_byte_array</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_mem_set_byte_array     (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
126
 
                                                         <link linkend="GByteArray">GByteArray</link> *buffer);</programlisting>
127
 
<para>
128
 
Set <parameter>buffer</parameter> to be the backing data to the existing <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>, <parameter>mem</parameter>.
129
 
</para>
130
 
<para>
131
 
Note: <parameter>mem</parameter> will not take ownership of <parameter>buffer</parameter> and so will need to
132
 
be freed separately from <parameter>mem</parameter>.</para>
133
 
<para>
134
 
</para><variablelist role="params">
135
 
<varlistentry><term><parameter>mem</parameter>&#160;:</term>
136
 
<listitem><simpara> a <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
139
 
<listitem><simpara> a <link linkend="GByteArray"><type>GByteArray</type></link>
140
 
</simpara></listitem></varlistentry>
141
 
</variablelist></refsect2>
142
 
<refsect2 id="camel-stream-mem-set-buffer" role="function">
143
 
<title>camel_stream_mem_set_buffer ()</title>
144
 
<indexterm zone="camel-stream-mem-set-buffer"><primary sortas="camel_stream_mem_set_buffer">camel_stream_mem_set_buffer</primary></indexterm><programlisting><link linkend="void">void</link>                camel_stream_mem_set_buffer         (<link linkend="CamelStreamMem">CamelStreamMem</link> *mem,
145
 
                                                         const <link linkend="gchar">gchar</link> *buffer,
146
 
                                                         <link linkend="gsize">gsize</link> len);</programlisting>
147
 
<para>
148
 
Set <parameter>buffer</parameter> to be the backing data to the existing <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link>, <parameter>mem</parameter>.
149
 
</para>
150
 
<para>
151
 
Note: <parameter>buffer</parameter> will be copied into an internal <link linkend="GByteArray"><type>GByteArray</type></link> structure
152
 
and so may have resource implications to consider.</para>
153
 
<para>
154
 
</para><variablelist role="params">
155
 
<varlistentry><term><parameter>mem</parameter>&#160;:</term>
156
 
<listitem><simpara> a <link linkend="CamelStreamMem"><type>CamelStreamMem</type></link> object
157
 
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
159
 
<listitem><simpara> a memory buffer
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
162
 
<listitem><simpara> length of <parameter>buffer</parameter>
163
 
</simpara></listitem></varlistentry>
164
 
</variablelist></refsect2>
165
 
 
166
 
</refsect1>
167
 
 
168
 
 
169
 
 
170
 
 
171
 
</refentry>