UF_DIRPATH_append (view source)
Defined in: uf_dirpath.h
Overview
Adds the directories of one path to another path.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_append
(
tag_t self,
const tag_t append
)
| tag_t | self | Input | Original path which will be augmented. |
| const tag_t | append | Input | Path to append from. |
UF_DIRPATH_append_from_dirs (view source)
Defined in: uf_dirpath.h
Overview
adds directories represented by strings to a path.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_append_from_dirs
(
tag_t self,
const int count,
const char * * dirs
)
| tag_t | self | Input | Original path / augmented path. |
| const int | count | Input | Number of directories to be appended. |
| const char * * | dirs | Input | Directories |
UF_DIRPATH_append_from_env (view source)
Defined in: uf_dirpath.h
Overview
Adds directories represented by environment variable strings to a path.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_append_from_env
(
tag_t self,
const char * env
)
| tag_t | self | Input | Original path / augumented path. |
| const char * | env | Input | Name of environment variable. |
UF_DIRPATH_ask_curr_dir (view source)
Defined in: uf_dirpath.h
Overview
Retrieves the name of the current directory (with respect to an internal
index) in a path. You must call UF_DIRPATH_start_dir_iteration prior to
calling this routine.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_curr_dir
(
tag_t self,
char * * dir
)
| tag_t | self | Input | path |
| char * * | dir | Output to UF_*free* | current directory. This must be freed by the calling program
using UF_free. |
UF_DIRPATH_ask_dir_count (view source)
Defined in: uf_dirpath.h
Overview
Returns the number of directories in a path.
Return
Number of directories
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_dir_count
(
tag_t self
)
UF_DIRPATH_ask_dir_index (view source)
Defined in: uf_dirpath.h
Overview
Returns the index of the current directory in a path.
It is best to use UF_DIRPATH_start_dir_iteration before ever using
UF_DIRPATH_ask_dir_index.
Return
index of current directory
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_dir_index
(
tag_t self
)
UF_DIRPATH_ask_dirs (view source)
Defined in: uf_dirpath.h
Overview
Extracts the directories from a path.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_dirs
(
tag_t self,
int * count,
char * * * dirs
)
| tag_t | self | Input | Path |
| int * | count | Output | Number of directories |
| char * * * | dirs | Output to UF_*free* | Array of directories. This must be freed by the caller, using
UF_free. |
UF_DIRPATH_ask_next_dir (view source)
Defined in: uf_dirpath.h
Overview
Retrieves the name of the next directory (with respect to an internal
index) in a path. You must call UF_DIRPATH_start_dir_iteration prior to
calling this routine.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_next_dir
(
tag_t self,
char * * dir
)
| tag_t | self | Input | Path |
| char * * | dir | Output to UF_*free* | Next directory. This must be freed by the calling program using
UF_free. |
UF_DIRPATH_ask_nth_dir (view source)
Defined in: uf_dirpath.h
Overview
Gets the nth (as specified by index) directory from a path.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_nth_dir
(
tag_t self,
const int index,
char * * dir
)
| tag_t | self | Input | Path |
| const int | index | Input | >=0 : Index of directory to locate in path |
| char * * | dir | Output to UF_*free* | nth directory. This is dynamically allocated, and must be
freed by the calling routine using UF_free. |
UF_DIRPATH_ask_prev_dir (view source)
Defined in: uf_dirpath.h
Overview
Retrieves the name of the previous directory (with respect to an internal
index) in a path. You must call UF_DIRPATH_start_dir_iteration prior to
calling this routine.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_ask_prev_dir
(
tag_t self,
char * * dir
)
| tag_t | self | Input | Path |
| char * * | dir | Output to UF_*free* | Previous directory. This must be freed by the caller using
UF_free. |
UF_DIRPATH_create_from_dirs (view source)
Defined in: uf_dirpath.h
Overview
Creates a path from directories represented by strings.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_create_from_dirs
(
const int count,
const char * * dirs,
tag_t * retval_tag
)
| const int | count | Input | number of directories |
| const char * * | dirs | Input | directories |
| tag_t * | retval_tag | Output | NULL_TAG or tag of path |
UF_DIRPATH_create_from_env (view source)
Defined in: uf_dirpath.h
Overview
Creates a path from the value of an environment variable.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_create_from_env
(
const char * env,
tag_t * retval_tag
)
| const char * | env | Input | name of environment variable |
| tag_t * | retval_tag | Output | NULL_TAG or tag of path |
UF_DIRPATH_find_file (view source)
Defined in: uf_dirpath.h
Overview
Finds the first file with a specific name in a path.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_find_file
(
tag_t self,
char * name,
char * * fpath
)
| tag_t | self | Input | Path |
| char * | name | Input | Name of file to find |
| char * * | fpath | Output to UF_*free* | Path of file to find. If the file is not found, then NULL is
returned. If the path is non-NULL, then the calling program
must free this by calling UF_free. |
UF_DIRPATH_start_dir_iteration (view source)
Defined in: uf_dirpath.h
Overview
This function is used to prepare to index through each directory in a path.
NOTE: This function should be called before using UF_DIRPATH_ask_next_dir,
UF_DIRPATH_ask_prev_dir, or UF_DIRPATH_ask_curr_dir.
Environment
Internal and External
See Also
Required License(s)
gateway
int UF_DIRPATH_start_dir_iteration
(
tag_t self
)