Path Group Functions

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

Functions

EAPI int ecore_path_group_new (char *group_name)
 Creates a new path group.
EAPI void ecore_path_group_del (int group_id)
 Destroys a previously created path group.
EAPI void ecore_path_group_add (int group_id, char *path)
 Adds a directory to be searched for files.
EAPI void ecore_path_group_remove (int group_id, char *path)
 Removes the given directory from the given group.
EAPI char * ecore_path_group_find (int group_id, char *name)
 Finds a file in a group of paths.
EAPI Ecore_List * ecore_path_group_available (int group_id)
 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 ( int  group_id,
char *  path 
)

Adds a directory to be searched for files.

Parameters:
group_id The unique identifier for the group to add the path.
path The new path to be added to the group.

EAPI Ecore_List* ecore_path_group_available ( int  group_id  ) 

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.

EAPI void ecore_path_group_del ( int  group_id  ) 

Destroys a previously created path group.

Parameters:
group_id The unique identifier for the group.

EAPI char* ecore_path_group_find ( int  group_id,
char *  name 
)

Finds a file in a group of paths.

Parameters:
group_id The path group id 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.

EAPI int ecore_path_group_new ( char *  group_name  ) 

Creates a new path group.

Parameters:
group_name The name of the new group.
Returns:
0 on error, the integer id of the new group on success.

EAPI void ecore_path_group_remove ( int  group_id,
char *  path 
)

Removes the given directory from the given group.

Parameters:
group_id The identifier for the given group.
path The path of the directory to be removed.