| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>memory: GSF Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="GSF Reference Manual"> |
| 8 |
<link rel="up" href="sources.html" title="Stream Sources"> |
| 9 |
<link rel="prev" href="gsf-Reading-and-Writing-from-local-files-and-directories.html" title="Reading and Writing from local files and directories"> |
| 10 |
<link rel="next" href="gsf-GIOChannel.html" title="GIOChannel"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#gsf-memory.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| 19 |
<a href="#gsf-memory.object-hierarchy" class="shortcut">Object Hierarchy</a></span> |
| 20 |
</td> |
| 21 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 22 |
<td><a accesskey="u" href="sources.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 23 |
<td><a accesskey="p" href="gsf-Reading-and-Writing-from-local-files-and-directories.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 24 |
<td><a accesskey="n" href="gsf-GIOChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 25 |
</tr></table> |
| 26 |
<div class="refentry"> |
| 27 |
<a name="gsf-memory"></a><div class="titlepage"></div> |
| 28 |
<div class="refnamediv"><table width="100%"><tr> |
| 29 |
<td valign="top"> |
| 30 |
<h2><span class="refentrytitle"><a name="gsf-memory.top_of_page"></a>memory</span></h2> |
| 31 |
<p>memory</p> |
| 32 |
</td> |
| 33 |
<td class="gallery_image" valign="top" align="right"></td> |
| 34 |
</tr></table></div> |
| 35 |
<div class="refsect1"> |
| 36 |
<a name="gsf-memory.functions"></a><h2>Functions</h2> |
| 37 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 38 |
<colgroup> |
| 39 |
<col width="150px" class="functions_proto_type"> |
| 40 |
<col class="functions_proto_name"> |
| 41 |
</colgroup> |
| 42 |
<tbody> |
| 43 |
<tr> |
| 44 |
<td class="function_type"> |
| 45 |
<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 46 |
</td> |
| 47 |
<td class="function_name"> |
| 48 |
<a class="link" href="gsf-memory.html#gsf-input-mmap-new" title="gsf_input_mmap_new ()">gsf_input_mmap_new</a> <span class="c_punctuation">()</span> |
| 49 |
</td> |
| 50 |
</tr> |
| 51 |
<tr> |
| 52 |
<td class="function_type"> |
| 53 |
<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 54 |
</td> |
| 55 |
<td class="function_name"> |
| 56 |
<a class="link" href="gsf-memory.html#gsf-input-memory-new" title="gsf_input_memory_new ()">gsf_input_memory_new</a> <span class="c_punctuation">()</span> |
| 57 |
</td> |
| 58 |
</tr> |
| 59 |
<tr> |
| 60 |
<td class="function_type"> |
| 61 |
<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 62 |
</td> |
| 63 |
<td class="function_name"> |
| 64 |
<a class="link" href="gsf-memory.html#gsf-input-memory-new-clone" title="gsf_input_memory_new_clone ()">gsf_input_memory_new_clone</a> <span class="c_punctuation">()</span> |
| 65 |
</td> |
| 66 |
</tr> |
| 67 |
<tr> |
| 68 |
<td class="function_type"> |
| 69 |
<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 70 |
</td> |
| 71 |
<td class="function_name"> |
| 72 |
<a class="link" href="gsf-memory.html#gsf-input-memory-new-from-iochannel" title="gsf_input_memory_new_from_iochannel ()">gsf_input_memory_new_from_iochannel</a> <span class="c_punctuation">()</span> |
| 73 |
</td> |
| 74 |
</tr> |
| 75 |
<tr> |
| 76 |
<td class="function_type">const <span class="returnvalue">guint8</span> * |
| 77 |
</td> |
| 78 |
<td class="function_name"> |
| 79 |
<a class="link" href="gsf-memory.html#gsf-output-memory-get-bytes" title="gsf_output_memory_get_bytes ()">gsf_output_memory_get_bytes</a> <span class="c_punctuation">()</span> |
| 80 |
</td> |
| 81 |
</tr> |
| 82 |
<tr> |
| 83 |
<td class="function_type"> |
| 84 |
<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * |
| 85 |
</td> |
| 86 |
<td class="function_name"> |
| 87 |
<a class="link" href="gsf-memory.html#gsf-output-memory-new" title="gsf_output_memory_new ()">gsf_output_memory_new</a> <span class="c_punctuation">()</span> |
| 88 |
</td> |
| 89 |
</tr> |
| 90 |
</tbody> |
| 91 |
</table></div> |
| 92 |
</div> |
| 93 |
<a name="GsfInputMemory"></a><a name="GsfOutputMemory"></a><a name="GsfSharedMemory"></a><div class="refsect1"> |
| 94 |
<a name="gsf-memory.other"></a><h2>Types and Values</h2> |
| 95 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 96 |
<colgroup> |
| 97 |
<col width="150px" class="other_proto_type"> |
| 98 |
<col class="other_proto_name"> |
| 99 |
</colgroup> |
| 100 |
<tbody> |
| 101 |
<tr> |
| 102 |
<td class="datatype_keyword"> </td> |
| 103 |
<td class="function_name"><a class="link" href="gsf-memory.html#GsfInputMemory-struct" title="GsfInputMemory">GsfInputMemory</a></td> |
| 104 |
</tr> |
| 105 |
<tr> |
| 106 |
<td class="datatype_keyword"> </td> |
| 107 |
<td class="function_name"><a class="link" href="gsf-memory.html#GsfOutputMemory-struct" title="GsfOutputMemory">GsfOutputMemory</a></td> |
| 108 |
</tr> |
| 109 |
</tbody> |
| 110 |
</table></div> |
| 111 |
</div> |
| 112 |
<div class="refsect1"> |
| 113 |
<a name="gsf-memory.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 114 |
<pre class="screen"> GObject |
| 115 |
<span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> |
| 116 |
<span class="lineart">│</span> <span class="lineart">╰──</span> GsfInputMemory |
| 117 |
<span class="lineart">├──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> |
| 118 |
<span class="lineart">│</span> <span class="lineart">╰──</span> GsfOutputMemory |
| 119 |
<span class="lineart">╰──</span> GsfSharedMemory |
| 120 |
</pre> |
| 121 |
</div> |
| 122 |
<div class="refsect1"> |
| 123 |
<a name="gsf-memory.description"></a><h2>Description</h2> |
| 124 |
</div> |
| 125 |
<div class="refsect1"> |
| 126 |
<a name="gsf-memory.functions_details"></a><h2>Functions</h2> |
| 127 |
<div class="refsect2"> |
| 128 |
<a name="gsf-input-mmap-new"></a><h3>gsf_input_mmap_new ()</h3> |
| 129 |
<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 130 |
gsf_input_mmap_new (<em class="parameter"><code><span class="type">char</span> const *filename</code></em>, |
| 131 |
<em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> |
| 132 |
<div class="refsect3"> |
| 133 |
<a name="gsf-input-mmap-new.parameters"></a><h4>Parameters</h4> |
| 134 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 135 |
<colgroup> |
| 136 |
<col width="150px" class="parameters_name"> |
| 137 |
<col class="parameters_description"> |
| 138 |
<col width="200px" class="parameters_annotations"> |
| 139 |
</colgroup> |
| 140 |
<tbody> |
| 141 |
<tr> |
| 142 |
<td class="parameter_name"><p>filename</p></td> |
| 143 |
<td class="parameter_description"><p>The file on disk that you want to mmap</p></td> |
| 144 |
<td class="parameter_annotations"> </td> |
| 145 |
</tr> |
| 146 |
<tr> |
| 147 |
<td class="parameter_name"><p>err</p></td> |
| 148 |
<td class="parameter_description"><p>A <span class="type">GError</span>. </p></td> |
| 149 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 150 |
</tr> |
| 151 |
</tbody> |
| 152 |
</table></div> |
| 153 |
</div> |
| 154 |
<div class="refsect3"> |
| 155 |
<a name="gsf-input-mmap-new.returns"></a><h4>Returns</h4> |
| 156 |
<p> A new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a></p> |
| 157 |
</div> |
| 158 |
</div> |
| 159 |
<hr> |
| 160 |
<div class="refsect2"> |
| 161 |
<a name="gsf-input-memory-new"></a><h3>gsf_input_memory_new ()</h3> |
| 162 |
<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 163 |
gsf_input_memory_new (<em class="parameter"><code><span class="type">guint8</span> const *buf</code></em>, |
| 164 |
<em class="parameter"><code><a class="link" href="gsf-Utilities.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> length</code></em>, |
| 165 |
<em class="parameter"><code><span class="type">gboolean</span> needs_free</code></em>);</pre> |
| 166 |
<div class="refsect3"> |
| 167 |
<a name="gsf-input-memory-new.parameters"></a><h4>Parameters</h4> |
| 168 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 169 |
<colgroup> |
| 170 |
<col width="150px" class="parameters_name"> |
| 171 |
<col class="parameters_description"> |
| 172 |
<col width="200px" class="parameters_annotations"> |
| 173 |
</colgroup> |
| 174 |
<tbody> |
| 175 |
<tr> |
| 176 |
<td class="parameter_name"><p>buf</p></td> |
| 177 |
<td class="parameter_description"><p>The input bytes. </p></td> |
| 178 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></td> |
| 179 |
</tr> |
| 180 |
<tr> |
| 181 |
<td class="parameter_name"><p>length</p></td> |
| 182 |
<td class="parameter_description"><p>The length of <em class="parameter"><code>buf</code></em> |
| 183 |
</p></td> |
| 184 |
<td class="parameter_annotations"> </td> |
| 185 |
</tr> |
| 186 |
<tr> |
| 187 |
<td class="parameter_name"><p>needs_free</p></td> |
| 188 |
<td class="parameter_description"><p>Whether you want this memory to be free'd at object destruction</p></td> |
| 189 |
<td class="parameter_annotations"> </td> |
| 190 |
</tr> |
| 191 |
</tbody> |
| 192 |
</table></div> |
| 193 |
</div> |
| 194 |
<div class="refsect3"> |
| 195 |
<a name="gsf-input-memory-new.returns"></a><h4>Returns</h4> |
| 196 |
<p> A new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a></p> |
| 197 |
</div> |
| 198 |
</div> |
| 199 |
<hr> |
| 200 |
<div class="refsect2"> |
| 201 |
<a name="gsf-input-memory-new-clone"></a><h3>gsf_input_memory_new_clone ()</h3> |
| 202 |
<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 203 |
gsf_input_memory_new_clone (<em class="parameter"><code><span class="type">guint8</span> const *buf</code></em>, |
| 204 |
<em class="parameter"><code><a class="link" href="gsf-Utilities.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> length</code></em>);</pre> |
| 205 |
<div class="refsect3"> |
| 206 |
<a name="gsf-input-memory-new-clone.parameters"></a><h4>Parameters</h4> |
| 207 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 208 |
<colgroup> |
| 209 |
<col width="150px" class="parameters_name"> |
| 210 |
<col class="parameters_description"> |
| 211 |
<col width="200px" class="parameters_annotations"> |
| 212 |
</colgroup> |
| 213 |
<tbody> |
| 214 |
<tr> |
| 215 |
<td class="parameter_name"><p>buf</p></td> |
| 216 |
<td class="parameter_description"><p>The input bytes. </p></td> |
| 217 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></td> |
| 218 |
</tr> |
| 219 |
<tr> |
| 220 |
<td class="parameter_name"><p>length</p></td> |
| 221 |
<td class="parameter_description"><p>The length of <em class="parameter"><code>buf</code></em> |
| 222 |
</p></td> |
| 223 |
<td class="parameter_annotations"> </td> |
| 224 |
</tr> |
| 225 |
</tbody> |
| 226 |
</table></div> |
| 227 |
</div> |
| 228 |
<div class="refsect3"> |
| 229 |
<a name="gsf-input-memory-new-clone.returns"></a><h4>Returns</h4> |
| 230 |
<p> A new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a></p> |
| 231 |
</div> |
| 232 |
</div> |
| 233 |
<hr> |
| 234 |
<div class="refsect2"> |
| 235 |
<a name="gsf-input-memory-new-from-iochannel"></a><h3>gsf_input_memory_new_from_iochannel ()</h3> |
| 236 |
<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> * |
| 237 |
gsf_input_memory_new_from_iochannel (<em class="parameter"><code><span class="type">GIOChannel</span> *channel</code></em>, |
| 238 |
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| 239 |
<div class="refsect3"> |
| 240 |
<a name="gsf-input-memory-new-from-iochannel.parameters"></a><h4>Parameters</h4> |
| 241 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 242 |
<colgroup> |
| 243 |
<col width="150px" class="parameters_name"> |
| 244 |
<col class="parameters_description"> |
| 245 |
<col width="200px" class="parameters_annotations"> |
| 246 |
</colgroup> |
| 247 |
<tbody> |
| 248 |
<tr> |
| 249 |
<td class="parameter_name"><p>channel</p></td> |
| 250 |
<td class="parameter_description"><p>a <span class="type">GIOChannel</span>.</p></td> |
| 251 |
<td class="parameter_annotations"> </td> |
| 252 |
</tr> |
| 253 |
<tr> |
| 254 |
<td class="parameter_name"><p>error</p></td> |
| 255 |
<td class="parameter_description"><p>a <span class="type">GError</span></p></td> |
| 256 |
<td class="parameter_annotations"> </td> |
| 257 |
</tr> |
| 258 |
</tbody> |
| 259 |
</table></div> |
| 260 |
</div> |
| 261 |
<div class="refsect3"> |
| 262 |
<a name="gsf-input-memory-new-from-iochannel.returns"></a><h4>Returns</h4> |
| 263 |
<p> a new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or <code class="literal">NULL</code>.</p> |
| 264 |
</div> |
| 265 |
</div> |
| 266 |
<hr> |
| 267 |
<div class="refsect2"> |
| 268 |
<a name="gsf-output-memory-get-bytes"></a><h3>gsf_output_memory_get_bytes ()</h3> |
| 269 |
<pre class="programlisting">const <span class="returnvalue">guint8</span> * |
| 270 |
gsf_output_memory_get_bytes (<em class="parameter"><code><a class="link" href="gsf-memory.html#GsfOutputMemory"><span class="type">GsfOutputMemory</span></a> *mem</code></em>);</pre> |
| 271 |
<div class="refsect3"> |
| 272 |
<a name="gsf-output-memory-get-bytes.parameters"></a><h4>Parameters</h4> |
| 273 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 274 |
<colgroup> |
| 275 |
<col width="150px" class="parameters_name"> |
| 276 |
<col class="parameters_description"> |
| 277 |
<col width="200px" class="parameters_annotations"> |
| 278 |
</colgroup> |
| 279 |
<tbody><tr> |
| 280 |
<td class="parameter_name"><p>mem</p></td> |
| 281 |
<td class="parameter_description"><p>the output device.</p></td> |
| 282 |
<td class="parameter_annotations"> </td> |
| 283 |
</tr></tbody> |
| 284 |
</table></div> |
| 285 |
</div> |
| 286 |
<div class="refsect3"> |
| 287 |
<a name="gsf-output-memory-get-bytes.returns"></a><h4>Returns</h4> |
| 288 |
<p>The data that has been written to <em class="parameter"><code>mem</code></em> |
| 289 |
. </p> |
| 290 |
<p><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 291 |
</div> |
| 292 |
</div> |
| 293 |
<hr> |
| 294 |
<div class="refsect2"> |
| 295 |
<a name="gsf-output-memory-new"></a><h3>gsf_output_memory_new ()</h3> |
| 296 |
<pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> * |
| 297 |
gsf_output_memory_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 298 |
<div class="refsect3"> |
| 299 |
<a name="gsf-output-memory-new.returns"></a><h4>Returns</h4> |
| 300 |
<p>a new file. </p> |
| 301 |
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| 302 |
</div> |
| 303 |
</div> |
| 304 |
</div> |
| 305 |
<div class="refsect1"> |
| 306 |
<a name="gsf-memory.other_details"></a><h2>Types and Values</h2> |
| 307 |
<div class="refsect2"> |
| 308 |
<a name="GsfInputMemory-struct"></a><h3>GsfInputMemory</h3> |
| 309 |
<pre class="programlisting">typedef struct _GsfInputMemory GsfInputMemory;</pre> |
| 310 |
</div> |
| 311 |
<hr> |
| 312 |
<div class="refsect2"> |
| 313 |
<a name="GsfOutputMemory-struct"></a><h3>GsfOutputMemory</h3> |
| 314 |
<pre class="programlisting">typedef struct _GsfOutputMemory GsfOutputMemory;</pre> |
| 315 |
</div> |
| 316 |
</div> |
| 317 |
</div> |
| 318 |
<div class="footer"> |
| 319 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 320 |
</body> |
| 321 |
</html> |