FileEnumerator

FileEnumerator

Object Hierarchy:

Description:

public class FileEnumerator : Object

FileEnumerator allows you to operate on a set of Files, returning a FileInfo structure for each file enumerated (e.g. enumerate_children will return a FileEnumerator for each of the children within a directory).

To get the next file's information from a FileEnumerator, use next_file or its asynchronous version, next_files_async. Note that the asynchronous version will return a list of FileInfos, whereas the synchronous will only return the next file in the enumerator.

To close a FileEnumerator, use close, or its asynchronous version, close_async. Once a FileEnumerator is closed, no further actions may be performed on it, and it should be freed with unref.

Namespace: GLib

Package: gio-2.0

Content:

Properties:

public File container { construct set; }

Creation methods:

protected FileEnumerator ()

Methods:

public bool close (Cancellable? cancellable = null) throws Error
Releases all resources used by this enumerator, making the enumerator return CLOSED on all calls.
public virtual async bool close_async (int io_priority = DEFAULT, Cancellable? cancellable = null) throws Error
Asynchronously closes the file enumerator.
public virtual bool close_fn (Cancellable? cancellable = null) throws Error
public weak File get_container ()
Get the File container which is being enumerated.
public bool has_pending ()
Checks if the file enumerator has pending operations.
public bool is_closed ()
Checks if the file enumerator has been closed.
public virtual FileInfo next_file (Cancellable? cancellable = null) throws Error
Returns information for the next file in the enumerated object. Will block until the information is available. The FileInfo returned from this function will contain attributes that match the attribute string that was passed when the FileEnumerator was created.
public virtual async List<FileInfo> next_files_async (int num_files, int io_priority = DEFAULT, Cancellable? cancellable = null) throws Error
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.
public void set_pending (bool pending)
Sets the file enumerator as having pending operations.