1
2
3
4
5
6
7
8
9gd_dirfilename(3) GETDATA gd_dirfilename(3)
10
11
12
14 gd_dirfilename — retrieve the name of a Dirfile
15
16
18 #include <getdata.h>
19
20 const char *gd_dirfilename(DIRFILE *dirfile);
21
22
24 The gd_dirfilename() function queries a dirfile(5) database specified
25 by dirfile and returns its name. The name of a dirfile is an absolute
26 pathname which refers to the dirfile base directory.
27
28 The dirfile argument must point to a valid DIRFILE object previously
29 created by a call to gd_open(3).
30
31
33 Upon successful completion, gd_dirfilename() returns a pointer to a
34 constant string containing the pathname of the dirfile. On error,
35 gd_dirfilename() returns NULL and stores a negative-valued error code
36 in the DIRFILE object which may be retrieved by a subsequent call to
37 gd_error(3). Possible error codes are:
38
39 GD_E_BAD_DIRFILE
40 The supplied dirfile was invalid.
41
42 A descriptive error string for the error may be obtained by calling
43 gd_error_string(3).
44
45
47 The function dirfilename() appeared in GetData-0.3.0.
48
49 In GetData-0.7.0, this function was renamed to gd_dirfilename().
50
51 In GetData-0.10.0, the error return from this function changed from -1
52 to a negative-valued error code.
53
54
56 gd_open(3), path_resolution(7)
57
58
59
60Version 0.10.0 25 December 2016 gd_dirfilename(3)