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
|
<refentry id="gsf-memory">
<refmeta>
<refentrytitle role="top_of_page">memory</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>memory</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GsfInputMemory"/><anchor id="GsfOutputMemory"/>
<synopsis>
<link linkend="GsfInputMemory-struct">GsfInputMemory</link>;
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-mmap-new">gsf_input_mmap_new</link> (<link linkend="char">char</link> const *filename,
<link linkend="GError">GError</link> **err);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-memory-new">gsf_input_memory_new</link> (<link linkend="guint8">guint8</link> const *buf,
<link linkend="gsf-off-t">gsf_off_t</link> length,
<link linkend="gboolean">gboolean</link> needs_free);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-memory-new-clone">gsf_input_memory_new_clone</link> (<link linkend="guint8">guint8</link> const *buf,
<link linkend="gsf-off-t">gsf_off_t</link> length);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-memory-new-from-iochannel">gsf_input_memory_new_from_iochannel</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GError">GError</link> **error);
<link linkend="GsfOutputMemory-struct">GsfOutputMemory</link>;
const <link linkend="guint8">guint8</link>* <link linkend="gsf-output-memory-get-bytes">gsf_output_memory_get_bytes</link> (<link linkend="GsfOutputMemory">GsfOutputMemory</link> *mem);
<link linkend="GType">GType</link> <link linkend="gsf-output-memory-get-type">gsf_output_memory_get_type</link> (void);
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-output-memory-new">gsf_output_memory_new</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfInput">GsfInput</link>
+----GsfInputMemory
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfOutput">GsfOutput</link>
+----GsfOutputMemory
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GsfInputMemory-struct" role="struct"/>GsfInputMemory</title>
<indexterm><primary>GsfInputMemory</primary></indexterm><programlisting>typedef struct _GsfInputMemory GsfInputMemory;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-input-mmap-new" role="function"/>gsf_input_mmap_new ()</title>
<indexterm><primary>gsf_input_mmap_new</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_mmap_new (<link linkend="char">char</link> const *filename,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> The file on disk that you want to mmap
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara> A <link linkend="GError"><type>GError</type></link>, or optionally <link linkend="null"><literal>null</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GsfInputMemory"><type>GsfInputMemory</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-memory-new" role="function"/>gsf_input_memory_new ()</title>
<indexterm><primary>gsf_input_memory_new</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_memory_new (<link linkend="guint8">guint8</link> const *buf,
<link linkend="gsf-off-t">gsf_off_t</link> length,
<link linkend="gboolean">gboolean</link> needs_free);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> The input bytes
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> The length of <parameter>buf</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>needs_free</parameter> :</term>
<listitem><simpara> Whether you want this memory to be free'd at object destruction
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GsfInputMemory"><type>GsfInputMemory</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-memory-new-clone" role="function"/>gsf_input_memory_new_clone ()</title>
<indexterm><primary>gsf_input_memory_new_clone</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_memory_new_clone (<link linkend="guint8">guint8</link> const *buf,
<link linkend="gsf-off-t">gsf_off_t</link> length);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> The input bytes
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> The length of <parameter>buf</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GsfInputMemory"><type>GsfInputMemory</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-memory-new-from-iochannel" role="function"/>gsf_input_memory_new_from_iochannel ()</title>
<indexterm><primary>gsf_input_memory_new_from_iochannel</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_memory_new_from_iochannel (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel</parameter> :</term>
<listitem><simpara> a <link linkend="GIOChannel"><type>GIOChannel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> a <link linkend="GError"><type>GError</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GsfInputMemory"><type>GsfInputMemory</type></link> or NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfOutputMemory-struct" role="struct"/>GsfOutputMemory</title>
<indexterm><primary>GsfOutputMemory</primary></indexterm><programlisting>typedef struct _GsfOutputMemory GsfOutputMemory;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-output-memory-get-bytes" role="function"/>gsf_output_memory_get_bytes ()</title>
<indexterm><primary>gsf_output_memory_get_bytes</primary></indexterm><programlisting>const <link linkend="guint8">guint8</link>* gsf_output_memory_get_bytes (<link linkend="GsfOutputMemory">GsfOutputMemory</link> *mem);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mem</parameter> :</term>
<listitem><simpara> the output device.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The data that has been written to <parameter>mem</parameter>, or <link linkend="null"><literal>null</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-memory-get-type" role="function"/>gsf_output_memory_get_type ()</title>
<indexterm><primary>gsf_output_memory_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link> gsf_output_memory_get_type (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-memory-new" role="function"/>gsf_output_memory_new ()</title>
<indexterm><primary>gsf_output_memory_new</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_output_memory_new (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new file or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
