Ecore_Path_Group (3) - Linux Manuals

Ecore_Path_Group: Functions that make it easier to find a file in a set of search paths.

NAME

Path Group Functions - Functions that make it easier to find a file in a set of search paths.

Functions

EAPI Ecore_Path_Group * ecore_path_group_new (void)
Creates a new path group.
EAPI void ecore_path_group_del (Ecore_Path_Group *group)
Destroys a previously created path group.
EAPI void ecore_path_group_add (Ecore_Path_Group *group, const char *path)
Adds a directory to be searched for files.
EAPI void ecore_path_group_remove (Ecore_Path_Group *group, const char *path)
Removes the given directory from the given group.
EAPI char * ecore_path_group_find (Ecore_Path_Group *group, const char *name)
Finds a file in a group of paths.
EAPI Ecore_List * ecore_path_group_available (Ecore_Path_Group *group)
Retrieves a list of all available files in the given path.

Detailed Description

Functions that make it easier to find a file in a set of search paths.

Todo

Give this a better description.

Function Documentation

EAPI void ecore_path_group_add (Ecore_Path_Group * group, const char * path)

Adds a directory to be searched for files.

Parameters:

group The group to add the path.
path The new path to be added to the group.

References ecore_list_append(), ecore_list_free_cb_set(), and ecore_list_new().

EAPI Ecore_List* ecore_path_group_available (Ecore_Path_Group * group)

Retrieves a list of all available files in the given path.

Parameters:

group_id The identifier for the given path.

Returns:

A pointer to a newly allocated list of all files found in the paths identified by group_id. NULL otherwise.

References ecore_list_append(), ecore_list_empty_is(), ecore_list_first_goto(), ecore_list_new(), and ecore_list_next().

EAPI void ecore_path_group_del (Ecore_Path_Group * group)

Destroys a previously created path group.

Parameters:

group The group to delete.

References ecore_list_destroy().

EAPI char* ecore_path_group_find (Ecore_Path_Group * group, const char * name)

Finds a file in a group of paths.

Parameters:

group The group to search.
name The name of the file to find.

Returns:

A pointer to a newly allocated path location of the found file on success. NULL on failure.

References ecore_list_first_goto(), and ecore_list_next().

Referenced by ecore_plugin_load().

EAPI Ecore_Path_Group* ecore_path_group_new (void)

Creates a new path group.

Parameters:

group_name The name of the new group.

Returns:

NULL on error, the handle of the new group on success.

EAPI void ecore_path_group_remove (Ecore_Path_Group * group, const char * path)

Removes the given directory from the given group.

Parameters:

group The group to remove the path from.
path The path of the directory to be removed.

References ecore_list_current(), ecore_list_first_goto(), ecore_list_next(), and ecore_list_remove_destroy().

Author

Generated automatically by Doxygen for Ecore from the source code.