📄 gfileenumerator.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>GFileEnumerator</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="file_ops.html" title="File Operations"><link rel="prev" href="GFileInfo.html" title="GFileInfo"><link rel="next" href="GMountOperation.html" title="GMountOperation"><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="GFileInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="file_ops.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="GMountOperation.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="#id3114234" class="shortcut">Top</a>  |  <a href="#id3116896" class="shortcut">Description</a>  |  <a href="#id3144669" class="shortcut">Object Hierarchy</a></nobr></td></tr></table><div class="refentry" lang="en"><a name="GFileEnumerator"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><a name="id3114234"></a><span class="refentrytitle">GFileEnumerator</span></h2><p>GFileEnumerator — Enumerated Files Routines</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="GFileEnumerator.html#GFileEnumerator-struct">GFileEnumerator</a>;<a class="link" href="GFileInfo.html" title="GFileInfo">GFileInfo</a>* <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-file">g_file_enumerator_next_file</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, <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="GFileEnumerator.html#g-file-enumerator-close">g_file_enumerator_close</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, <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="GFileEnumerator.html#g-file-enumerator-next-files-async">g_file_enumerator_next_files_async</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, int num_files, 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-Doubly-Linked-Lists.html#GList">GList</a>* <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-files-finish">g_file_enumerator_next_files_finish</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, <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="GFileEnumerator.html#g-file-enumerator-close-async">g_file_enumerator_close_async</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, 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="GFileEnumerator.html#g-file-enumerator-close-finish">g_file_enumerator_close_finish</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, <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="GFileEnumerator.html#g-file-enumerator-is-closed">g_file_enumerator_is_closed</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GFileEnumerator.html#g-file-enumerator-has-pending">g_file_enumerator_has_pending</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator);void <a class="link" href="GFileEnumerator.html#g-file-enumerator-set-pending">g_file_enumerator_set_pending</a> (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> pending);</pre></div><div class="refsect1" lang="en"><a name="id3144669"></a><h2>Object Hierarchy</h2><pre class="synopsis"> <ahref="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----GFileEnumerator</pre></div><div class="refsect1" lang="en"><a name="id3116896"></a><h2>Description</h2><p><a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> allows you to operate on a set of <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>s, returning a <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> structure for each file enumerated (e.g. <a class="link" href="GFile.html#g-file-enumerate-children"><code class="function">g_file_enumerate_children()</code></a> will return a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> for each of the children within a directory).</p><p>To get the next file's information from a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>, use <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-file"><code class="function">g_file_enumerator_next_file()</code></a> or its asynchronous version, <code class="function">g_file_enumerator_next_file_async()</code>. Note that the asynchronous version will return a list of <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>s, whereas the synchronous will only return the next file in the enumerator.</p><p>To close a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>, use <a class="link" href="GFileEnumerator.html#g-file-enumerator-close"><code class="function">g_file_enumerator_close()</code></a>, or its asynchronous version, <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-async"><code class="function">g_file_enumerator_close_async()</code></a>. Once a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> is closed, no further actions may be performed on it, and it should be freed with <ahref="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p><p></p></div><div class="refsect1" lang="en"><a name="id3117045"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3152569"></a><h3><a name="GFileEnumerator-struct"></a>GFileEnumerator</h3><a class="indexterm" name="id3152580"></a><pre class="programlisting">typedef struct _GFileEnumerator GFileEnumerator;</pre><p>A per matched file iterator.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3152606"></a><h3><a name="g-file-enumerator-next-file"></a>g_file_enumerator_next_file ()</h3><a class="indexterm" name="id3152617"></a><pre class="programlisting"><a class="link" href="GFileInfo.html" title="GFileInfo">GFileInfo</a>* g_file_enumerator_next_file (<a class="link" href="GFileEnumerator.html" title="GFileEnumerator">GFileEnumerator</a> *enumerator, <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>Returns information for the next file in the enumerated object.Will block until the information is available. The <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> returned from this function will contain attributes that match the attribute string that was passed when the <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> was created.</p><p>On error, returns <ahref="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> and sets <em class="parameter"><code>error</code></em> to the error. If theenumerator is at the end, <ahref="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned and <em class="parameter"><code>error</code></em> willbe unset.</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>enumerator</code></em> :</span></p></td><td> a <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a>.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td><td> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <ahref="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -