Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.FileEnumerator

Class Gio.FileEnumerator

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GFileEnumerator
Class :	FileEnumerator
Extends:	GObject.Object

GFileEnumerator allows you to operate on a set of GFiles,
returning a GFileInfo structure for each file enumerated (e.g.
g_file_enumerate_children() will return a GFileEnumerator for each
of the children within a directory).
To get the next file's information from a GFileEnumerator, use
g_file_enumerator_next_file() or its asynchronous version,
g_file_enumerator_next_files_async(). Note that the asynchronous
version will return a list of GFileInfos, whereas the
synchronous will only return the next file in the enumerator.
To close a GFileEnumerator, use g_file_enumerator_close(), or
its asynchronous version, g_file_enumerator_close_async(). Once
a GFileEnumerator is closed, no further actions may be performed
on it, and it should be freed with g_object_unref().

Properties
Properties		Defined By
	container : Gio.File	Gio.FileEnumerator
	parent_instance : GObject.Object read only	Gio.FileEnumerator
	priv : Gio.FileEnumeratorPrivate read only	Gio.FileEnumerator

Methods / Constructors
Method / Constructor		Defined By
	new Gio.FileEnumerator (Object *properties) Create a new Gio.FileEnumerator Create a new Gio.FileEnumerator Parameters: Object properties*
	close (Cancellable *cancellable) : gboolean Releases all resources used by this enumerator, making the enumerator return G_IO_ERROR_CLOSED* on all calls. Releases all resources used by this enumerator, making the enumerator return G_IO_ERROR_CLOSED on all calls. This will be automatically called when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible. Parameters: Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: gboolean TRUE on success or FALSE on error.	Gio.FileEnumerator
	close_async (gint32 *io_priority, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously closes the file enumerator. Asynchronously closes the file enumerator. If cancellable* is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned in g_file_enumerator_close_finish(). Parameters: gint32 io_priority Required (not null) the I/O priority of the request. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback* to call when the request is satisfied void* user_data Required (not null) the data to pass to callback function Returns: none	Gio.FileEnumerator
	close_finish (AsyncResult *result) : gboolean Finishes closing a file enumerator, started from g_file_enumerator_close_async(). Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report G_IO_ERROR_CLOSED* in error, and return FALSE. If the file enumerator had pending operation when the close operation was started, then this function will report G_IO_ERROR_PENDING, and return FALSE. If cancellable was not NULL, then the operation may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be set, and FALSE will be returned. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult. Returns: gboolean TRUE if the close operation has finished successfully.	Gio.FileEnumerator
	get_container () : Gio.File Get the GFile container which is being enumerated. Get the GFile container which is being enumerated. Returns: Gio.File the GFile which is being enumerated.	Gio.FileEnumerator
	has_pending () : gboolean Checks if the file enumerator has pending operations. Checks if the file enumerator has pending operations. Returns: gboolean TRUE if the enumerator has pending operations.	Gio.FileEnumerator
	is_closed () : gboolean Checks if the file enumerator has been closed. Checks if the file enumerator has been closed. Returns: gboolean TRUE if the enumerator is closed.	Gio.FileEnumerator
	next_file (Cancellable *cancellable) : Gio.FileInfo Returns information for the next file in the enumerated object. Returns information for the next file in the enumerated object. Will block until the information is available. The GFileInfo* returned from this function will contain attributes that match the attribute string that was passed when the GFileEnumerator was created. On error, returns NULL and sets error to the error. If the enumerator is at the end, NULL will be returned and error will be unset. Free the returned object with g_object_unref() when no longer needed. Parameters: Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: Gio.FileInfo A GFileInfo or NULL on error or end of enumerator.	Gio.FileEnumerator
	next_files_async (gint32 *num_files, gint32 io_priority, Cancellable cancellable, Function callback, void *user_data) : none Request information for a number of files from the enumerator asynchronously. Request information for a number of files from the enumerator asynchronously. When all i/o for the operation is finished the callback* will be called with the requested information. The callback can be called with less than num_files files in case of error or at the end of the enumerator. In case of a partial error the callback will be called with any succeeding items and no error, and on the next request the error will be reported. If a request is cancelled the callback will be called with G_IO_ERROR_CANCELLED. During an async request no other sync and async calls are allowed, and will result in G_IO_ERROR_PENDING errors. Any outstanding i/o request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is G_PRIORITY_DEFAULT. Parameters: gint32 num_files Required (not null) the number of file info objects to request gint32 io_priority Required (not null) the io priority of the request. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback* to call when the request is satisfied void* user_data Required (not null) the data to pass to callback function Returns: none	Gio.FileEnumerator
	next_files_finish (AsyncResult *result) : Array Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). g_list_free() and unref the infos with g_object_unref() when you're done with them. Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: Array a GList of GFileInfos. You must free the list with	Gio.FileEnumerator
	set_pending (gboolean *pending) : none Sets the file enumerator as having pending operations. Sets the file enumerator as having pending operations. Parameters: gboolean pending* Required (not null) a boolean value. Returns: none	Gio.FileEnumerator

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio.File Method	enumerate_children (String *attributes, FileQueryInfoFlags flags, Cancellable cancellable*) : Gio.FileEnumerator Gets the requested information about the files in a directory.
Gio.File Method	enumerate_children_finish (AsyncResult *res*) : Gio.FileEnumerator Finishes an async enumerate children operation.