gd_dirfilename man page

gd_dirfilename — retrieve the name of a dirfile

Synopsis

#include <getdata.h>

const char *gd_dirfilename(DIRFILE *dirfile);

Description

The gd_dirfilename() function queries a dirfile(5) database specified by dirfile and returns its name. The name of a dirfile is an absolute pathname which refers to the dirfile base directory.

The dirfile argument must point to a valid DIRFILE object previously created by a call to gd_open(3).

Return Value

Upon successful completion, gd_dirfilename() returns a pointer to a constant string containing the pathname of the dirfile. On error, gd_dirfilename() returns NULL and sets the dirfile error to a non-zero value. Possible error values are:

GD_E_BAD_DIRFILE
The supplied dirfile was invalid.

The dirfile error may be retrieved by calling gd_error(3). A descriptive error string for the last error encountered can be obtained from a call to gd_error_string(3).

See Also

gd_cbopen(3), path_resolution(7)

Info

1 August 2012 Version 0.8.1 GETDATA