📄 ginputstream.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"><title>GInputStream</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="GIO Reference Manual"><link rel="up" href="streaming.html" title="Streaming I/O"><link rel="prev" href="GSeekable.html" title="GSeekable"><link rel="next" href="GOutputStream.html" title="GOutputStream"><meta name="generator" content="GTK-Doc V1.9 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="pt01.html" title="Part I. GIO Overview"><link rel="chapter" href="ch01.html" title="Introduction"><link rel="chapter" href="ch02.html" title="Compiling GIO applications"><link rel="chapter" href="ch03.html" title="Running GIO applications"><link rel="chapter" href="gio-extension-points.html" title="Extending GIO"><link rel="part" href="pt02.html" title="Part II. API Reference"><link rel="chapter" href="file_ops.html" title="File Operations"><link rel="chapter" href="file_mon.html" title="File System Monitoring"><link rel="chapter" href="async.html" title="Asynchronous I/O"><link rel="chapter" href="streaming.html" title="Streaming I/O"><link rel="chapter" href="types.html" title="File types and applications"><link rel="chapter" href="volume_mon.html" title="Volumes and Drives"><link rel="chapter" href="icons.html" title="Icons"><link rel="chapter" href="utils.html" title="Utilities"><link rel="chapter" href="extending.html" title="Extending GIO"><link rel="part" href="migrating.html" title="Part III. Migrating to GIO"><link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO"><link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO"><link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy"><link rel="index" href="ix01.html" title="Index"></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="2"><tr valign="middle"><td><a accesskey="p" href="GSeekable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="streaming.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIO Reference Manual</th><td><a accesskey="n" href="GOutputStream.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr><tr><td colspan="5" class="shortcuts"><nobr><a href="#id3124819" class="shortcut">Top</a>  |  <a href="#id3086509" class="shortcut">Description</a>  |  <a href="#id3086460" class="shortcut">Object Hierarchy</a></nobr></td></tr></table><div class="refentry" lang="en"><a name="GInputStream"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><a name="id3124819"></a><span class="refentrytitle">GInputStream</span></h2><p>GInputStream — Base class for implementing streaming input</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">#include <gio/gio.h> <a class="link" href="GInputStream.html#GInputStream-struct">GInputStream</a>;<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize">gssize</a> <a class="link" href="GInputStream.html#g-input-stream-read">g_input_stream_read</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, void *buffer, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> count, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GInputStream.html#g-input-stream-read-all">g_input_stream_read_all</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, void *buffer, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> count, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> *bytes_read, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize">gssize</a> <a class="link" href="GInputStream.html#g-input-stream-skip">g_input_stream_skip</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> count, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GInputStream.html#g-input-stream-close">g_input_stream_close</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);void <a class="link" href="GInputStream.html#g-input-stream-read-async">g_input_stream_read_async</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, void *buffer, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> count, int io_priority, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize">gssize</a> <a class="link" href="GInputStream.html#g-input-stream-read-finish">g_input_stream_read_finish</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);void <a class="link" href="GInputStream.html#g-input-stream-skip-async">g_input_stream_skip_async</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> count, int io_priority, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize">gssize</a> <a class="link" href="GInputStream.html#g-input-stream-skip-finish">g_input_stream_skip_finish</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);void <a class="link" href="GInputStream.html#g-input-stream-close-async">g_input_stream_close_async</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, int io_priority, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <a class="link" href="GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GInputStream.html#g-input-stream-close-finish">g_input_stream_close_finish</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GInputStream.html#g-input-stream-is-closed">g_input_stream_is_closed</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GInputStream.html#g-input-stream-has-pending">g_input_stream_has_pending</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GInputStream.html#g-input-stream-set-pending">g_input_stream_set_pending</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);void <a class="link" href="GInputStream.html#g-input-stream-clear-pending">g_input_stream_clear_pending</a> (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream);</pre></div><div class="refsect1" lang="en"><a name="id3086460"></a><h2>Object Hierarchy</h2><pre class="synopsis"> <ahref="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----GInputStream +----<a class="link" href="GUnixInputStream.html" title="GUnixInputStream">GUnixInputStream</a> +----<a class="link" href="GMemoryInputStream.html" title="GMemoryInputStream">GMemoryInputStream</a> +----<a class="link" href="GFilterInputStream.html" title="GFilterInputStream">GFilterInputStream</a> +----<a class="link" href="GFileInputStream.html" title="GFileInputStream">GFileInputStream</a></pre></div><div class="refsect1" lang="en"><a name="id3086509"></a><h2>Description</h2><p></p><p></p></div><div class="refsect1" lang="en"><a name="id3086529"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3086540"></a><h3><a name="GInputStream-struct"></a>GInputStream</h3><a class="indexterm" name="id3086552"></a><pre class="programlisting">typedef struct _GInputStream GInputStream;</pre><p>Base class for streaming input operations.</p><p></p></div><hr><div class="refsect2" lang="en"><a name="id3186312"></a><h3><a name="g-input-stream-read"></a>g_input_stream_read ()</h3><a class="indexterm" name="id3186324"></a><pre class="programlisting"><ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize">gssize</a> g_input_stream_read (<a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *stream, void *buffer, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> count, <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);</pre><p>Tries to read <em class="parameter"><code>count</code></em> bytes from the stream into the buffer starting at<em class="parameter"><code>buffer</code></em>. Will block during this read.</p><p>If count is zero returns zero and does nothing. A value of <em class="parameter"><code>count</code></em>larger than <ahref="/usr/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.</p><p>On success, the number of bytes read into the buffer is returned.It is not an error if this is not the same as the requested size, as itcan happen e.g. near the end of a file. Zero is returned on end of file(or if <em class="parameter"><code>count</code></em> is zero), but never otherwise.</p><p>If <em class="parameter"><code>cancellable</code></em> is not NULL, then the operation can be cancelled bytriggering the cancellable object from another thread. If the operationwas cancelled, the error G_IO_ERROR_CANCELLED will be returned. If anoperation was partially finished when the operation was cancelled thepartial result will be returned, without an error.</p><p>On error -1 is returned and <em class="parameter"><code>error</code></em> is set accordingly.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td><td> a <a class="link" href="GInputStream.html" title="GInputStream"><span class="type">GInputStream</span></a>.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td><td> a buffer to read data into (which should be at least count bytes long).</td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -