Directory Operations

Name

Directory Operations -- loading and parsing directory contents

Synopsis



GnomeVFSResult gnome_vfs_directory_open     (GnomeVFSDirectoryHandle **handle,
                                             const gchar *text_uri,
                                             GnomeVFSFileInfoOptions options,
                                             const GnomeVFSDirectoryFilter *filter);
GnomeVFSResult gnome_vfs_directory_open_from_uri
                                            (GnomeVFSDirectoryHandle **handle,
                                             GnomeVFSURI *uri,
                                             GnomeVFSFileInfoOptions options,
                                             const GnomeVFSDirectoryFilter *filter);
GnomeVFSResult gnome_vfs_directory_read_next
                                            (GnomeVFSDirectoryHandle *handle,
                                             GnomeVFSFileInfo *info);
GnomeVFSResult gnome_vfs_directory_close    (GnomeVFSDirectoryHandle *handle);
GnomeVFSResult gnome_vfs_directory_visit    (const gchar *uri,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);
GnomeVFSResult gnome_vfs_directory_visit_uri
                                            (GnomeVFSURI *uri,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);
GnomeVFSResult gnome_vfs_directory_visit_files
                                            (const gchar *text_uri,
                                             GList *file_list,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);
GnomeVFSResult gnome_vfs_directory_visit_files_at_uri
                                            (GnomeVFSURI *uri,
                                             GList *file_list,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);
GnomeVFSResult gnome_vfs_directory_list_load
                                            (GList **list,
                                             const gchar *text_uri,
                                             GnomeVFSFileInfoOptions options,
                                             const GnomeVFSDirectoryFilter *filter);

Description

Details

gnome_vfs_directory_open ()

GnomeVFSResult gnome_vfs_directory_open     (GnomeVFSDirectoryHandle **handle,
                                             const gchar *text_uri,
                                             GnomeVFSFileInfoOptions options,
                                             const GnomeVFSDirectoryFilter *filter);

Open directory text_uri for reading. On return, @*handle will point to a GnomeVFSDirectoryHandle object which can be used to read the directory entries one by one.

handle :

A pointer to a pointer to a GnomeVFSDirectoryHandle object

text_uri :

String representing the URI to open

options :

Options for reading file information

filter :

Filter to be applied to the directory entries

Returns :

An integer representing the result of the operation.


gnome_vfs_directory_open_from_uri ()

GnomeVFSResult gnome_vfs_directory_open_from_uri
                                            (GnomeVFSDirectoryHandle **handle,
                                             GnomeVFSURI *uri,
                                             GnomeVFSFileInfoOptions options,
                                             const GnomeVFSDirectoryFilter *filter);

Open directory text_uri for reading. On return, @*handle will point to a GnomeVFSDirectoryHandle object which can be used to read the directory entries one by one.

handle :

A pointer to a pointer to a GnomeVFSDirectoryHandle object

uri :

URI to open

options :

Options for reading file information

filter :

Filter to be applied to the directory entries

Returns :

An integer representing the result of the operation.


gnome_vfs_directory_read_next ()

GnomeVFSResult gnome_vfs_directory_read_next
                                            (GnomeVFSDirectoryHandle *handle,
                                             GnomeVFSFileInfo *info);

Read the next directory entry from handle.

handle :

A directory handle

info :

Returns :

An integer value representing the result of the operation.


gnome_vfs_directory_close ()

GnomeVFSResult gnome_vfs_directory_close    (GnomeVFSDirectoryHandle *handle);

Close handle.

handle :

A directory handle.

Returns :

An integer representing the result of the operation.


gnome_vfs_directory_visit ()

GnomeVFSResult gnome_vfs_directory_visit    (const gchar *uri,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);

Visit uri, retrieving information as specified by info_options. Also, filter will be applied.

uri :

URI to start from

info_options :

Options specifying what kind of file information must be retrieved

filter :

Filter to be used while visiting the directory

Param4 :

callback :

Callback to be called for every visited file

data :

Data to be passed to callback at each iteration

Returns :


gnome_vfs_directory_visit_uri ()

GnomeVFSResult gnome_vfs_directory_visit_uri
                                            (GnomeVFSURI *uri,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);

Visit uri, retrieving information as specified by info_options. Also, filter will be applied.

uri :

URI to start from

info_options :

Options specifying what kind of file information must be retrieved

filter :

Filter to be used while visiting the directory

Param4 :

callback :

Callback to be called for every visited file

data :

Data to be passed to callback at each iteration

Returns :


gnome_vfs_directory_visit_files ()

GnomeVFSResult gnome_vfs_directory_visit_files
                                            (const gchar *text_uri,
                                             GList *file_list,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);

text_uri :

file_list :

info_options :

filter :

Param5 :

callback :

data :

Returns :


gnome_vfs_directory_visit_files_at_uri ()

GnomeVFSResult gnome_vfs_directory_visit_files_at_uri
                                            (GnomeVFSURI *uri,
                                             GList *file_list,
                                             GnomeVFSFileInfoOptions info_options,
                                             const GnomeVFSDirectoryFilter *filter,
                                             GnomeVFSDirectoryVisitOptionsvisit_options,
                                             GnomeVFSDirectoryVisitFunc callback,
                                             gpointer data);

uri :

file_list :

info_options :

filter :

Param5 :

callback :

data :

Returns :


gnome_vfs_directory_list_load ()

GnomeVFSResult gnome_vfs_directory_list_load
                                            (GList **list,
                                             const gchar *text_uri,
                                             GnomeVFSFileInfoOptions options,
                                             const GnomeVFSDirectoryFilter *filter);

Load a directory from text_uri with the specified options into a list. Directory entries are filtered through filter.

list :

An address of a pointer to a list of GnomeVFSFileInfo

text_uri :

A text URI

options :

Options for loading the directory

filter :

Filter to be applied to the files being read

Returns :

An integer representing the result of the operation.