RubyGems - gsf - Versions diffs - 3.0.9-x64-mingw32 - Mend

gsf 3.0.9-x64-mingw32

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-memory.html ADDED Viewed

@@ -0,0 +1,332 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GSF Reference Manual: memory</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="GSF Reference Manual">
+<link rel="up" href="sources.html" title="Stream Sources">
+<link rel="prev" href="gsf-Reading-and-Writing-from-local-files-and-directories.html" title="Reading and Writing from local files and directories">
+<link rel="next" href="gsf-GIOChannel.html" title="GIOChannel">
+<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
+                  <a href="#gsf-memory.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-memory.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="sources.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<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>
+<td><a accesskey="n" href="gsf-GIOChannel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="gsf-memory"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gsf-memory.top_of_page"></a>memory</span></h2>
+<p>memory</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-memory.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr>
+<tr>
+<td class="function_type">const <span class="returnvalue">guint8</span> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfInputMemory"></a><a name="GsfOutputMemory"></a><a name="GsfSharedMemory"></a><div class="refsect1">
+<a name="gsf-memory.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-memory.html#GsfInputMemory-struct" title="GsfInputMemory">GsfInputMemory</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-memory.html#GsfOutputMemory-struct" title="GsfOutputMemory">GsfOutputMemory</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-memory.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+    <span class="lineart">│</span>   <span class="lineart">╰──</span> GsfInputMemory
+    <span class="lineart">├──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
+    <span class="lineart">│</span>   <span class="lineart">╰──</span> GsfOutputMemory
+    <span class="lineart">╰──</span> GsfSharedMemory
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-memory.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-memory.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-input-mmap-new"></a><h3>gsf_input_mmap_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_mmap_new (<em class="parameter"><code><span class="type">char</span> const *filename</code></em>,
+                    <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.2.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>filename</p></td>
+<td class="parameter_description"><p>The file on disk that you want to mmap</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p>A <span class="type">GError</span>, or optionally <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.2.5"></a><h4>Returns</h4>
+<p> A new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a></p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-memory-new"></a><h3>gsf_input_memory_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_memory_new (<em class="parameter"><code><span class="type">guint8</span> const *buf</code></em>,
+                      <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> length</code></em>,
+                      <em class="parameter"><code><span class="type">gboolean</span> needs_free</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.3.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>buf</p></td>
+<td class="parameter_description"><p>The input bytes</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>length</p></td>
+<td class="parameter_description"><p>The length of <em class="parameter"><code>buf</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>needs_free</p></td>
+<td class="parameter_description"><p>Whether you want this memory to be free'd at object destruction</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.3.5"></a><h4>Returns</h4>
+<p> A new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a></p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-memory-new-clone"></a><h3>gsf_input_memory_new_clone ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_memory_new_clone (<em class="parameter"><code><span class="type">guint8</span> const *buf</code></em>,
+                            <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> length</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.4.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>buf</p></td>
+<td class="parameter_description"><p>The input bytes</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>length</p></td>
+<td class="parameter_description"><p>The length of <em class="parameter"><code>buf</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.4.5"></a><h4>Returns</h4>
+<p> A new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a></p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-memory-new-from-iochannel"></a><h3>gsf_input_memory_new_from_iochannel ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_memory_new_from_iochannel (<em class="parameter"><code><span class="type">GIOChannel</span> *channel</code></em>,
+                                     <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.5.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>channel</p></td>
+<td class="parameter_description"><p>a <span class="type">GIOChannel</span>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>a <span class="type">GError</span></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.5.5"></a><h4>Returns</h4>
+<p> a new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or <code class="literal">NULL</code>.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-memory-get-bytes"></a><h3>gsf_output_memory_get_bytes ()</h3>
+<pre class="programlisting">const <span class="returnvalue">guint8</span> *
+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>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.6.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>mem</p></td>
+<td class="parameter_description"><p>the output device.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.6.5"></a><h4>Returns</h4>
+<p> The data that has been written to <em class="parameter"><code>mem</code></em>
+, or <code class="literal">NULL</code></p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-memory-new"></a><h3>gsf_output_memory_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
+gsf_output_memory_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.4.5.10.7.4"></a><h4>Returns</h4>
+<p> a new file or <code class="literal">NULL</code>.</p>
+<p></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-memory.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfInputMemory-struct"></a><h3>GsfInputMemory</h3>
+<pre class="programlisting">typedef struct _GsfInputMemory GsfInputMemory;</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutputMemory-struct"></a><h3>GsfOutputMemory</h3>
+<pre class="programlisting">typedef struct _GsfOutputMemory GsfOutputMemory;</pre>
+<p>
+</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>