1dirfilename(3)                      GETDATA                     dirfilename(3)
2
3
4

NAME

6       dirfilename — retrieve the name of a dirfile
7

SYNOPSIS

9       #include <getdata.h>
10
11       const char *dirfilename(const DIRFILE *dirfile);
12

DESCRIPTION

14       The  dirfilename()  function queries a dirfile(5) database specified by
15       dirfile and returns its name.  The name of a dirfile  is  the  pathname
16       passed  to  dirfile_cbopen()  or  dirfile_open()  when  the dirfile was
17       opened.
18
19       The dirfile argument must point to a valid  DIRFILE  object  previously
20       created by a call to dirfile_open(3).
21
22

RETURN VALUE

24       Upon  successful  completion, dirfilename() returns a pointer to a con‐
25       stant string  containing  the  pathname  of  the  dirfile.   On  error,
26       dirfilename()  returns  NULL  and  sets the dirfile error to a non-zero
27       value.  Possible error values are:
28
29       GD_E_BAD_DIRFILE
30               The supplied dirfile was invalid.
31
32       The dirfile error may be retrieved by calling get_error(3).  A descrip‐
33       tive error string for the last error encountered can be obtained from a
34       call to get_error_string(3).
35

SEE ALSO

37       dirfile_cbopen(3)
38
39
40
41Version 0.5.0                   8 December 2008                 dirfilename(3)
Impressum