← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gmemoryinputstream.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gmemoryinputstream.xml
5
5
]>
6
6
<refentry id="GMemoryInputStream">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GMemoryInputStream</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GMemoryInputStream.top_of_page">GMemoryInputStream</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GMemoryInputStream</refname>
15
15
<refpurpose>Streaming input operations on memory chunks</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GMemoryInputStream.synopsis" role="synopsis">
20
19
<title role="synopsis.title">Synopsis</title>
21
20
 
22
21
<synopsis>
23
22
 
24
23
#include &lt;gio/gio.h&gt;
25
24
 
26
 
 
27
25
                    <link linkend="GMemoryInputStream-struct">GMemoryInputStream</link>;
28
 
<link linkend="GInputStream">GInputStream</link>*       <link linkend="g-memory-input-stream-new">g_memory_input_stream_new</link>           (void);
29
 
<link linkend="GInputStream">GInputStream</link>*       <link linkend="g-memory-input-stream-new-from-data">g_memory_input_stream_new_from_data</link> (const <link linkend="void">void</link> *data,
 
26
<link linkend="GInputStream">GInputStream</link> *      <link linkend="g-memory-input-stream-new">g_memory_input_stream_new</link>           (void);
 
27
<link linkend="GInputStream">GInputStream</link> *      <link linkend="g-memory-input-stream-new-from-data">g_memory_input_stream_new_from_data</link> (const <link linkend="void">void</link> *data,
30
28
                                                         <link linkend="gssize">gssize</link> len,
31
29
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);
32
30
<link linkend="void">void</link>                <link linkend="g-memory-input-stream-add-data">g_memory_input_stream_add_data</link>      (<link linkend="GMemoryInputStream">GMemoryInputStream</link> *stream,
33
31
                                                         const <link linkend="void">void</link> *data,
34
32
                                                         <link linkend="gssize">gssize</link> len,
35
33
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);
36
 
 
37
 
 
38
34
</synopsis>
39
35
</refsynopsisdiv>
40
36
 
41
 
<refsect1 role="object_hierarchy">
 
37
<refsect1 id="GMemoryInputStream.object-hierarchy" role="object_hierarchy">
42
38
<title role="object_hierarchy.title">Object Hierarchy</title>
43
39
<synopsis>
44
 
 
45
40
  <link linkend="GObject">GObject</link>
46
41
   +----<link linkend="GInputStream">GInputStream</link>
47
42
         +----GMemoryInputStream
48
43
</synopsis>
49
 
 
50
44
</refsect1>
51
45
 
52
46
 
53
47
 
54
 
<refsect1 role="impl_interfaces">
 
48
<refsect1 id="GMemoryInputStream.implemented-interfaces" role="impl_interfaces">
55
49
<title role="impl_interfaces.title">Implemented Interfaces</title>
56
50
<para>
57
51
GMemoryInputStream implements
58
52
 <link linkend="GSeekable">GSeekable</link>.</para>
59
 
 
60
53
</refsect1>
61
54
 
62
55
 
63
56
 
64
57
 
65
58
 
66
 
<refsect1 role="desc">
 
59
<refsect1 id="GMemoryInputStream.description" role="desc">
67
60
<title role="desc.title">Description</title>
68
61
<para>
69
62
<link linkend="GMemoryInputStream"><type>GMemoryInputStream</type></link> is a class for using arbitrary
70
63
memory chunks as input for GIO streaming input operations.</para>
71
64
<para>
72
 
 
73
65
</para>
74
66
</refsect1>
75
67
 
76
 
<refsect1 role="details">
 
68
<refsect1 id="GMemoryInputStream.details" role="details">
77
69
<title role="details.title">Details</title>
78
 
<refsect2>
79
 
<title><anchor id="GMemoryInputStream-struct" role="struct"/>GMemoryInputStream</title>
80
 
<indexterm><primary>GMemoryInputStream</primary></indexterm><programlisting>typedef struct _GMemoryInputStream GMemoryInputStream;</programlisting>
 
70
<refsect2 id="GMemoryInputStream-struct" role="struct">
 
71
<title>GMemoryInputStream</title>
 
72
<indexterm zone="GMemoryInputStream-struct"><primary sortas="GMemoryInputStream">GMemoryInputStream</primary></indexterm><programlisting>typedef struct _GMemoryInputStream GMemoryInputStream;</programlisting>
81
73
<para>
82
74
Implements <link linkend="GInputStream"><type>GInputStream</type></link> for arbitrary memory chunks.</para>
83
75
<para>
84
 
 
85
76
</para></refsect2>
86
 
<refsect2>
87
 
<title><anchor id="g-memory-input-stream-new" role="function"/>g_memory_input_stream_new ()</title>
88
 
<indexterm><primary>g_memory_input_stream_new</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link>*       g_memory_input_stream_new           (void);</programlisting>
 
77
<refsect2 id="g-memory-input-stream-new" role="function">
 
78
<title>g_memory_input_stream_new ()</title>
 
79
<indexterm zone="g-memory-input-stream-new"><primary sortas="g_memory_input_stream_new">g_memory_input_stream_new</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link> *      g_memory_input_stream_new           (void);</programlisting>
89
80
<para>
90
81
Creates a new empty <link linkend="GMemoryInputStream"><type>GMemoryInputStream</type></link>.</para>
91
82
<para>
92
 
 
93
83
</para><variablelist role="params">
94
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GInputStream"><type>GInputStream</type></link>
 
84
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GInputStream"><type>GInputStream</type></link>
95
85
</simpara></listitem></varlistentry>
96
86
</variablelist></refsect2>
97
 
<refsect2>
98
 
<title><anchor id="g-memory-input-stream-new-from-data" role="function"/>g_memory_input_stream_new_from_data ()</title>
99
 
<indexterm><primary>g_memory_input_stream_new_from_data</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link>*       g_memory_input_stream_new_from_data (const <link linkend="void">void</link> *data,
 
87
<refsect2 id="g-memory-input-stream-new-from-data" role="function">
 
88
<title>g_memory_input_stream_new_from_data ()</title>
 
89
<indexterm zone="g-memory-input-stream-new-from-data"><primary sortas="g_memory_input_stream_new_from_data">g_memory_input_stream_new_from_data</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link> *      g_memory_input_stream_new_from_data (const <link linkend="void">void</link> *data,
100
90
                                                         <link linkend="gssize">gssize</link> len,
101
91
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);</programlisting>
102
92
<para>
103
93
Creates a new <link linkend="GMemoryInputStream"><type>GMemoryInputStream</type></link> with data in memory of a given size.</para>
104
94
<para>
105
 
 
106
95
</para><variablelist role="params">
107
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
96
<varlistentry><term><parameter>data</parameter>&#160;:</term>
108
97
<listitem><simpara> input data
109
98
</simpara></listitem></varlistentry>
110
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
99
<varlistentry><term><parameter>len</parameter>&#160;:</term>
111
100
<listitem><simpara> length of the data, may be -1 if <parameter>data</parameter> is a nul-terminated string
112
101
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
114
 
<listitem><simpara> function that is called to free <parameter>data</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
102
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
 
103
<listitem><simpara> function that is called to free <parameter>data</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
115
104
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> new <link linkend="GInputStream"><type>GInputStream</type></link> read from <parameter>data</parameter> of <parameter>len</parameter> bytes.
 
105
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> new <link linkend="GInputStream"><type>GInputStream</type></link> read from <parameter>data</parameter> of <parameter>len</parameter> bytes.
117
106
</simpara></listitem></varlistentry>
118
107
</variablelist></refsect2>
119
 
<refsect2>
120
 
<title><anchor id="g-memory-input-stream-add-data" role="function"/>g_memory_input_stream_add_data ()</title>
121
 
<indexterm><primary>g_memory_input_stream_add_data</primary></indexterm><programlisting><link linkend="void">void</link>                g_memory_input_stream_add_data      (<link linkend="GMemoryInputStream">GMemoryInputStream</link> *stream,
 
108
<refsect2 id="g-memory-input-stream-add-data" role="function">
 
109
<title>g_memory_input_stream_add_data ()</title>
 
110
<indexterm zone="g-memory-input-stream-add-data"><primary sortas="g_memory_input_stream_add_data">g_memory_input_stream_add_data</primary></indexterm><programlisting><link linkend="void">void</link>                g_memory_input_stream_add_data      (<link linkend="GMemoryInputStream">GMemoryInputStream</link> *stream,
122
111
                                                         const <link linkend="void">void</link> *data,
123
112
                                                         <link linkend="gssize">gssize</link> len,
124
113
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy);</programlisting>
125
114
<para>
126
115
Appends <parameter>data</parameter> to data that can be read from the input stream</para>
127
116
<para>
128
 
 
129
117
</para><variablelist role="params">
130
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
131
119
<listitem><simpara> a <link linkend="GMemoryInputStream"><type>GMemoryInputStream</type></link>
132
120
</simpara></listitem></varlistentry>
133
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
121
<varlistentry><term><parameter>data</parameter>&#160;:</term>
134
122
<listitem><simpara> input data
135
123
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
124
<varlistentry><term><parameter>len</parameter>&#160;:</term>
137
125
<listitem><simpara> length of the data, may be -1 if <parameter>data</parameter> is a nul-terminated string
138
126
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
140
 
<listitem><simpara> function that is called to free <parameter>data</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
127
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
 
128
<listitem><simpara> function that is called to free <parameter>data</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
141
129
</simpara></listitem></varlistentry>
142
130
</variablelist></refsect2>
143
131
 
145
133
 
146
134
 
147
135
 
148
 
<refsect1>
 
136
<refsect1 id="GMemoryInputStream.see-also">
149
137
<title>See Also</title>
150
 
<link linkend="GMemoryOutputStream"><type>GMemoryOutputStream</type></link>
 
138
#GMemoryOutputStream
151
139
</refsect1>
152
140
 
153
 
 
154
 
<refsect1><refsect2 /><refsect2 /></refsect1>
155
141
</refentry>