NAME

       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  path‐
       name  of the dirfile.  On error, gd_dirfilename() returns NULL and stores a negative-valued error code in
       the DIRFILE object which may be retrieved by a subsequent call to gd_error(3).  Possible error codes are:

       GD_E_BAD_DIRFILE
               The supplied dirfile was invalid.

       A descriptive error string for the error may be obtained by calling gd_error_string(3).

HISTORY

       The function dirfilename() appeared in GetData-0.3.0.

       In GetData-0.7.0, this function was renamed to gd_dirfilename().

       In GetData-0.10.0, the error return from this function changed from -1 to a negative-valued error code.

SEE ALSO

       gd_open(3), path_resolution(7)

Version 0.10.0                                  25 December 2016                               gd_dirfilename(3)