/usr/share/gtk-doc/html/camel/CamelStreamMem.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelStreamMem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="CamelStreamFs.html" title="CamelStreamFs">
<link rel="next" href="CamelStreamNull.html" title="CamelStreamNull">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="CamelStreamFs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelStreamNull.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelStreamMem.synopsis" class="shortcut">Top</a>
|
<a href="#CamelStreamMem.description" class="shortcut">Description</a>
|
<a href="#CamelStreamMem.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelStreamMem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelStreamMem.top_of_page"></a>CamelStreamMem</span></h2>
<p>CamelStreamMem</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelStreamMem.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelStreamMem.html#CamelStreamMem-struct" title="struct CamelStreamMem">CamelStreamMem</a>;
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="CamelStreamMem.html#camel-stream-mem-new" title="camel_stream_mem_new ()">camel_stream_mem_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="CamelStreamMem.html#camel-stream-mem-new-with-byte-array" title="camel_stream_mem_new_with_byte_array ()">camel_stream_mem_new_with_byte_array</a>
(<em class="parameter"><code><span class="type">GByteArray</span> *buffer</code></em>);
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="CamelStreamMem.html#camel-stream-mem-new-with-buffer" title="camel_stream_mem_new_with_buffer ()">camel_stream_mem_new_with_buffer</a> (<em class="parameter"><code>const <span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelStreamMem.html#camel-stream-mem-set-secure" title="camel_stream_mem_set_secure ()">camel_stream_mem_set_secure</a> (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>);
<span class="returnvalue">GByteArray</span> * <a class="link" href="CamelStreamMem.html#camel-stream-mem-get-byte-array" title="camel_stream_mem_get_byte_array ()">camel_stream_mem_get_byte_array</a> (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelStreamMem.html#camel-stream-mem-set-byte-array" title="camel_stream_mem_set_byte_array ()">camel_stream_mem_set_byte_array</a> (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>,
<em class="parameter"><code><span class="type">GByteArray</span> *buffer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelStreamMem.html#camel-stream-mem-set-buffer" title="camel_stream_mem_set_buffer ()">camel_stream_mem_set_buffer</a> (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelStreamMem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----<a class="link" href="CamelStream.html" title="CamelStream">CamelStream</a>
+----CamelStreamMem
</pre>
</div>
<div class="refsect1">
<a name="CamelStreamMem.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelStreamMem.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelStreamMem-struct"></a><h3>struct CamelStreamMem</h3>
<pre class="programlisting">struct CamelStreamMem;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-new"></a><h3>camel_stream_mem_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_stream_mem_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-new-with-byte-array"></a><h3>camel_stream_mem_new_with_byte_array ()</h3>
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_stream_mem_new_with_byte_array
(<em class="parameter"><code><span class="type">GByteArray</span> *buffer</code></em>);</pre>
<p>
Create a new <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> using <em class="parameter"><code>buffer</code></em> as the stream data.
</p>
<p>
Note: The newly created <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> will destroy <em class="parameter"><code>buffer</code></em>
when destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a <span class="type">GByteArray</span> to use as the stream data</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-new-with-buffer"></a><h3>camel_stream_mem_new_with_buffer ()</h3>
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_stream_mem_new_with_buffer (<em class="parameter"><code>const <span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>);</pre>
<p>
Create a new memory stream using <em class="parameter"><code>buffer</code></em> as the stream data.
</p>
<p>
Note: <em class="parameter"><code>buffer</code></em> will be copied into an internal <span class="type">GByteArray</span> structure
for use as the stream backing. This may have resource implications
you may wish to consider.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a memory buffer to use as the stream data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>length of <em class="parameter"><code>buffer</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-set-secure"></a><h3>camel_stream_mem_set_secure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_stream_mem_set_secure (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>);</pre>
<p>
Mark the memory stream as secure. At the very least this means the
data in the buffer will be cleared when the buffer is finalized.
This only applies to buffers owned by the stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-get-byte-array"></a><h3>camel_stream_mem_get_byte_array ()</h3>
<pre class="programlisting"><span class="returnvalue">GByteArray</span> * camel_stream_mem_get_byte_array (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-set-byte-array"></a><h3>camel_stream_mem_set_byte_array ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_stream_mem_set_byte_array (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>,
<em class="parameter"><code><span class="type">GByteArray</span> *buffer</code></em>);</pre>
<p>
Set <em class="parameter"><code>buffer</code></em> to be the backing data to the existing <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a>, <em class="parameter"><code>mem</code></em>.
</p>
<p>
Note: <em class="parameter"><code>mem</code></em> will not take ownership of <em class="parameter"><code>buffer</code></em> and so will need to
be freed separately from <em class="parameter"><code>mem</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a <span class="type">GByteArray</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-mem-set-buffer"></a><h3>camel_stream_mem_set_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_stream_mem_set_buffer (<em class="parameter"><code><a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> *mem</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>);</pre>
<p>
Set <em class="parameter"><code>buffer</code></em> to be the backing data to the existing <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a>, <em class="parameter"><code>mem</code></em>.
</p>
<p>
Note: <em class="parameter"><code>buffer</code></em> will be copied into an internal <span class="type">GByteArray</span> structure
and so may have resource implications to consider.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStreamMem.html" title="CamelStreamMem"><span class="type">CamelStreamMem</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a memory buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>length of <em class="parameter"><code>buffer</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|