docs/reference/gio/html/gio-GWin32OutputStream.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>GWin32OutputStream</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.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-GWin32InputStream.html" title="GWin32InputStream">
  10 <link rel="next" href="gio-GConverterInputstream.html" title="GConverterInputstream">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gio-GWin32InputStream.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="streaming.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="gio-GConverterInputstream.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gio-GWin32OutputStream.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gio-GWin32OutputStream.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gio-GWin32OutputStream"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gio-GWin32OutputStream.top_of_page"></a>GWin32OutputStream</span></h2>
  34 <p>GWin32OutputStream — Streaming output operations for Windows file handles</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gio-GWin32OutputStream.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gio/gwin32outputstream.h&gt;
  42
  43 struct              <a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream">GWin32OutputStream</a>;
  44 <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="returnvalue">GOutputStream</span></a> *     <a class="link" href="gio-GWin32OutputStream.html#g-win32-output-stream-new" title="g_win32_output_stream_new ()">g_win32_output_stream_new</a>           (<em class="parameter"><code><span class="type">void</span> *handle</code></em>,
  45                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_handle</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="gio-GWin32OutputStream.html#g-win32-output-stream-set-close-handle" title="g_win32_output_stream_set_close_handle ()">g_win32_output_stream_set_close_handle</a>
  47                                                         (<em class="parameter"><code><a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> *stream</code></em>,
  48                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_handle</code></em>);
  49 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-GWin32OutputStream.html#g-win32-output-stream-get-close-handle" title="g_win32_output_stream_get_close_handle ()">g_win32_output_stream_get_close_handle</a>
  50                                                         (<em class="parameter"><code><a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> *stream</code></em>);
  51 <span class="returnvalue">void</span> *              <a class="link" href="gio-GWin32OutputStream.html#g-win32-output-stream-get-handle" title="g_win32_output_stream_get_handle ()">g_win32_output_stream_get_handle</a>    (<em class="parameter"><code><a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> *stream</code></em>);
  52 </pre>
  53 </div>
  54 <div class="refsect1">
  55 <a name="gio-GWin32OutputStream.description"></a><h2>Description</h2>
  56 <p>
  57 <a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> implements <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a> for writing to a
  58 Windows file handle.
  59 </p>
  60 <p>
  61 Note that <code class="filename">&lt;gio/gwin32outputstream.h&gt;</code> belongs
  62 to the Windows-specific GIO interfaces, thus you have to use the
  63 <code class="filename">gio-windows-2.0.pc</code> pkg-config file when using it.
  64 </p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gio-GWin32OutputStream.details"></a><h2>Details</h2>
  68 <div class="refsect2">
  69 <a name="GWin32OutputStream"></a><h3>struct GWin32OutputStream</h3>
  70 <pre class="programlisting">struct GWin32OutputStream {
  71   GOutputStream parent_instance;
  72 };
  73 </pre>
  74 <p>
  75 Implements <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a> for outputting to Windows file handles
  76 </p>
  77 </div>
  78 <hr>
  79 <div class="refsect2">
  80 <a name="g-win32-output-stream-new"></a><h3>g_win32_output_stream_new ()</h3>
  81 <pre class="programlisting"><a class="link" href="GOutputStream.html" title="GOutputStream"><span class="returnvalue">GOutputStream</span></a> *     g_win32_output_stream_new           (<em class="parameter"><code><span class="type">void</span> *handle</code></em>,
  82                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_handle</code></em>);</pre>
  83 <p>
  84 Creates a new <a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> for the given <em class="parameter"><code>handle</code></em>.
  85 </p>
  86 <p>
  87 If <em class="parameter"><code>close_handle</code></em>, is <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the handle will be closed when the
  88 output stream is destroyed.
  89 </p>
  90 <div class="variablelist"><table border="0">
  91 <col align="left" valign="top">
  92 <tbody>
  93 <tr>
  94 <td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
  95 <td>a Win32 file handle</td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>close_handle</code></em> :</span></p></td>
  99 <td>
 100 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the handle when done</td>
 101 </tr>
 102 <tr>
 103 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 104 <td>a new <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>
 105 </td>
 106 </tr>
 107 </tbody>
 108 </table></div>
 109 <p class="since">Since 2.26</p>
 110 </div>
 111 <hr>
 112 <div class="refsect2">
 113 <a name="g-win32-output-stream-set-close-handle"></a><h3>g_win32_output_stream_set_close_handle ()</h3>
 114 <pre class="programlisting"><span class="returnvalue">void</span>                g_win32_output_stream_set_close_handle
 115                                                         (<em class="parameter"><code><a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> *stream</code></em>,
 116                                                          <em class="parameter"><code><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> close_handle</code></em>);</pre>
 117 <p>
 118 Sets whether the handle of <em class="parameter"><code>stream</code></em> shall be closed when the stream
 119 is closed.
 120 </p>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 126 <td>a <a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a>
 127 </td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><em class="parameter"><code>close_handle</code></em> :</span></p></td>
 131 <td>
 132 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to close the handle when done</td>
 133 </tr>
 134 </tbody>
 135 </table></div>
 136 <p class="since">Since 2.26</p>
 137 </div>
 138 <hr>
 139 <div class="refsect2">
 140 <a name="g-win32-output-stream-get-close-handle"></a><h3>g_win32_output_stream_get_close_handle ()</h3>
 141 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_win32_output_stream_get_close_handle
 142                                                         (<em class="parameter"><code><a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> *stream</code></em>);</pre>
 143 <p>
 144 Returns whether the handle of <em class="parameter"><code>stream</code></em> will be closed when the
 145 stream is closed.
 146 </p>
 147 <div class="variablelist"><table border="0">
 148 <col align="left" valign="top">
 149 <tbody>
 150 <tr>
 151 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 152 <td>a <a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a>
 153 </td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 157 <td>
 158 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the handle is closed when done</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <p class="since">Since 2.26</p>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="g-win32-output-stream-get-handle"></a><h3>g_win32_output_stream_get_handle ()</h3>
 167 <pre class="programlisting"><span class="returnvalue">void</span> *              g_win32_output_stream_get_handle    (<em class="parameter"><code><a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a> *stream</code></em>);</pre>
 168 <p>
 169 Return the Windows handle that the stream writes to.
 170 </p>
 171 <div class="variablelist"><table border="0">
 172 <col align="left" valign="top">
 173 <tbody>
 174 <tr>
 175 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 176 <td>a <a class="link" href="gio-GWin32OutputStream.html#GWin32OutputStream" title="struct GWin32OutputStream"><span class="type">GWin32OutputStream</span></a>
 177 </td>
 178 </tr>
 179 <tr>
 180 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 181 <td>The handle descriptor of <em class="parameter"><code>stream</code></em>
 182 </td>
 183 </tr>
 184 </tbody>
 185 </table></div>
 186 <p class="since">Since 2.26</p>
 187 </div>
 188 </div>
 189 <div class="refsect1">
 190 <a name="gio-GWin32OutputStream.see-also"></a><h2>See Also</h2>
 191 <a class="link" href="GOutputStream.html" title="GOutputStream"><span class="type">GOutputStream</span></a>
 192 </div>
 193 </div>
 194 <div class="footer">
 195 <hr>
 196           Generated by GTK-Doc V1.18</div>
 197 </body>
 198 </html>