synce_get_directory man page

synce_get_directory — get synce configuration directory

Synopsis

#include <synce.h>

bool synce_get_directory(char ** path);

bool synce_get_subdirectory(const char * name, char ** path);

bool synce_get_script_directory(char ** path);

Description

The synce_get_directory() function provides a string describing the location of the synce configuration directory. If the environment variable SYNCE_CONF_DIR is set, it's value is returned. The default location is ~/.synce.

The synce_get_subdirectory() function provides a string describing the location of the subdirectory name in the synce configuration directory. name cannot contain '/'.

The synce_get_script_directory() function provides a string describing the location of the script subdirectory in the synce configuration directory.

Return Value

Returns true if successful. Fails and returns false if path is an invalid pointer, SYNCE_CONF_DIR is not set and user cannot be determined, or the directory does not exist.

See Also

synce(7)

Referenced By

synce_get_connection_filename(3).

synce_get_script_directory(3) and synce_get_subdirectory(3) are aliases of synce_get_directory(3).

2007-08-26 The SynCE Project http://www.synce.org/