docs/reference/gio/html/gio-GConverterInputstream.html

   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>GConverterInputstream: GIO Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="streaming.html" title="Streaming I/O">
   9 <link rel="prev" href="gio-GWin32OutputStream.html" title="GWin32OutputStream">
  10 <link rel="next" href="gio-GConverterOutputstream.html" title="GConverterOutputstream">
  11 <meta name="generator" content="GTK-Doc V1.25.1 (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="#gio-GConverterInputstream.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#gio-GConverterInputstream.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span>
  20                   <a href="#gio-GConverterInputstream.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span>
  21                   <a href="#gio-GConverterInputstream.properties" class="shortcut">Properties</a></span>
  22 </td>
  23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  24 <td><a accesskey="u" href="streaming.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  25 <td><a accesskey="p" href="gio-GWin32OutputStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  26 <td><a accesskey="n" href="gio-GConverterOutputstream.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  27 </tr></table>
  28 <div class="refentry">
  29 <a name="gio-GConverterInputstream"></a><div class="titlepage"></div>
  30 <div class="refnamediv"><table width="100%"><tr>
  31 <td valign="top">
  32 <h2><span class="refentrytitle"><a name="gio-GConverterInputstream.top_of_page"></a>GConverterInputstream</span></h2>
  33 <p>GConverterInputstream — Converter Input Stream</p>
  34 </td>
  35 <td class="gallery_image" valign="top" align="right"></td>
  36 </tr></table></div>
  37 <div class="refsect1">
  38 <a name="gio-GConverterInputstream.functions"></a><h2>Functions</h2>
  39 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  40 <colgroup>
  41 <col width="150px" class="functions_return">
  42 <col class="functions_name">
  43 </colgroup>
  44 <tbody>
  45 <tr>
  46 <td class="function_type">
  47 <a class="link" href="GInputStream.html" title="GInputStream"><span class="returnvalue">GInputStream</span></a> *
  48 </td>
  49 <td class="function_name">
  50 <a class="link" href="gio-GConverterInputstream.html#g-converter-input-stream-new" title="g_converter_input_stream_new ()">g_converter_input_stream_new</a> <span class="c_punctuation">()</span>
  51 </td>
  52 </tr>
  53 <tr>
  54 <td class="function_type">
  55 <a class="link" href="GConverter.html" title="GConverter"><span class="returnvalue">GConverter</span></a> *
  56 </td>
  57 <td class="function_name">
  58 <a class="link" href="gio-GConverterInputstream.html#g-converter-input-stream-get-converter" title="g_converter_input_stream_get_converter ()">g_converter_input_stream_get_converter</a> <span class="c_punctuation">()</span>
  59 </td>
  60 </tr>
  61 </tbody>
  62 </table></div>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gio-GConverterInputstream.properties"></a><h2>Properties</h2>
  66 <div class="informaltable"><table class="informaltable" border="0">
  67 <colgroup>
  68 <col width="150px" class="properties_type">
  69 <col width="300px" class="properties_name">
  70 <col width="200px" class="properties_flags">
  71 </colgroup>
  72 <tbody><tr>
  73 <td class="property_type">
  74 <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> *</td>
  75 <td class="property_name"><a class="link" href="gio-GConverterInputstream.html#GConverterInputStream--converter" title="The “converter” property">converter</a></td>
  76 <td class="property_flags">Read / Write / Construct Only</td>
  77 </tr></tbody>
  78 </table></div>
  79 </div>
  80 <a name="GConverterInputStream"></a><div class="refsect1">
  81 <a name="gio-GConverterInputstream.other"></a><h2>Types and Values</h2>
  82 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  83 <colgroup>
  84 <col width="150px" class="name">
  85 <col class="description">
  86 </colgroup>
  87 <tbody><tr>
  88 <td class="datatype_keyword"> </td>
  89 <td class="function_name"><a class="link" href="gio-GConverterInputstream.html#GConverterInputStream-struct" title="GConverterInputStream">GConverterInputStream</a></td>
  90 </tr></tbody>
  91 </table></div>
  92 </div>
  93 <div class="refsect1">
  94 <a name="gio-GConverterInputstream.object-hierarchy"></a><h2>Object Hierarchy</h2>
  95 <pre class="screen">    <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
  96     <span class="lineart">╰──</span> <a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>
  97         <span class="lineart">╰──</span> <a class="link" href="GFilterInputStream.html" title="GFilterInputStream">GFilterInputStream</a>
  98             <span class="lineart">╰──</span> GConverterInputStream
  99 </pre>
 100 </div>
 101 <div class="refsect1">
 102 <a name="gio-GConverterInputstream.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 103 <p>
 104 GConverterInputStream implements
 105  <a class="link" href="GPollableInputStream.html" title="GPollableInputStream">GPollableInputStream</a>.</p>
 106 </div>
 107 <div class="refsect1">
 108 <a name="gio-GConverterInputstream.includes"></a><h2>Includes</h2>
 109 <pre class="synopsis">#include &lt;gio/gio.h&gt;
 110 </pre>
 111 </div>
 112 <div class="refsect1">
 113 <a name="gio-GConverterInputstream.description"></a><h2>Description</h2>
 114 <p>Converter input stream implements <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> and allows
 115 conversion of data of various types during reading.</p>
 116 <p>As of GLib 2.34, <a class="link" href="gio-GConverterInputstream.html#GConverterInputStream"><span class="type">GConverterInputStream</span></a> implements
 117 <a class="link" href="GPollableInputStream.html" title="GPollableInputStream"><span class="type">GPollableInputStream</span></a>.</p>
 118 </div>
 119 <div class="refsect1">
 120 <a name="gio-GConverterInputstream.functions_details"></a><h2>Functions</h2>
 121 <div class="refsect2">
 122 <a name="g-converter-input-stream-new"></a><h3>g_converter_input_stream_new ()</h3>
 123 <pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream"><span class="returnvalue">GInputStream</span></a> *
 124 g_converter_input_stream_new (<em class="parameter"><code><a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a> *base_stream</code></em>,
 125                               <em class="parameter"><code><a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> *converter</code></em>);</pre>
 126 <p>Creates a new converter input stream for the <em class="parameter"><code>base_stream</code></em>
 127 .</p>
 128 <div class="refsect3">
 129 <a name="g-converter-input-stream-new.parameters"></a><h4>Parameters</h4>
 130 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 131 <colgroup>
 132 <col width="150px" class="parameters_name">
 133 <col class="parameters_description">
 134 <col width="200px" class="parameters_annotations">
 135 </colgroup>
 136 <tbody>
 137 <tr>
 138 <td class="parameter_name"><p>base_stream</p></td>
 139 <td class="parameter_description"><p>a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a></p></td>
 140 <td class="parameter_annotations"> </td>
 141 </tr>
 142 <tr>
 143 <td class="parameter_name"><p>converter</p></td>
 144 <td class="parameter_description"><p>a <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a></p></td>
 145 <td class="parameter_annotations"> </td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 </div>
 150 <div class="refsect3">
 151 <a name="g-converter-input-stream-new.returns"></a><h4>Returns</h4>
 152 <p> a new <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.</p>
 153 </div>
 154 </div>
 155 <hr>
 156 <div class="refsect2">
 157 <a name="g-converter-input-stream-get-converter"></a><h3>g_converter_input_stream_get_converter ()</h3>
 158 <pre class="programlisting"><a class="link" href="GConverter.html" title="GConverter"><span class="returnvalue">GConverter</span></a> *
 159 g_converter_input_stream_get_converter
 160                                (<em class="parameter"><code><a class="link" href="gio-GConverterInputstream.html#GConverterInputStream"><span class="type">GConverterInputStream</span></a> *converter_stream</code></em>);</pre>
 161 <p>Gets the <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> that is used by <em class="parameter"><code>converter_stream</code></em>
 162 .</p>
 163 <div class="refsect3">
 164 <a name="g-converter-input-stream-get-converter.parameters"></a><h4>Parameters</h4>
 165 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 166 <colgroup>
 167 <col width="150px" class="parameters_name">
 168 <col class="parameters_description">
 169 <col width="200px" class="parameters_annotations">
 170 </colgroup>
 171 <tbody><tr>
 172 <td class="parameter_name"><p>converter_stream</p></td>
 173 <td class="parameter_description"><p>a <a class="link" href="gio-GConverterInputstream.html#GConverterInputStream"><span class="type">GConverterInputStream</span></a></p></td>
 174 <td class="parameter_annotations"> </td>
 175 </tr></tbody>
 176 </table></div>
 177 </div>
 178 <div class="refsect3">
 179 <a name="g-converter-input-stream-get-converter.returns"></a><h4>Returns</h4>
 180 <p> the converter of the converter input stream. </p>
 181 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 182 </div>
 183 <p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p>
 184 </div>
 185 </div>
 186 <div class="refsect1">
 187 <a name="gio-GConverterInputstream.other_details"></a><h2>Types and Values</h2>
 188 <div class="refsect2">
 189 <a name="GConverterInputStream-struct"></a><h3>GConverterInputStream</h3>
 190 <pre class="programlisting">typedef struct _GConverterInputStream GConverterInputStream;</pre>
 191 <p>An implementation of <a class="link" href="GFilterInputStream.html" title="GFilterInputStream"><span class="type">GFilterInputStream</span></a> that allows data
 192 conversion.</p>
 193 </div>
 194 </div>
 195 <div class="refsect1">
 196 <a name="gio-GConverterInputstream.property-details"></a><h2>Property Details</h2>
 197 <div class="refsect2">
 198 <a name="GConverterInputStream--converter"></a><h3>The <code class="literal">“converter”</code> property</h3>
 199 <pre class="programlisting">  “converter”                <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a> *</pre>
 200 <p>The converter object.</p>
 201 <p>Flags: Read / Write / Construct Only</p>
 202 </div>
 203 </div>
 204 <div class="refsect1">
 205 <a name="gio-GConverterInputstream.see-also"></a><h2>See Also</h2>
 206 <p><a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>, <a class="link" href="GConverter.html" title="GConverter"><span class="type">GConverter</span></a></p>
 207 </div>
 208 </div>
 209 <div class="footer">
 210 <hr>Generated by GTK-Doc V1.25.1</div>
 211 </body>
 212 </html>