dirfilename (3) - Linux Manuals

dirfilename: retrieve the name of a dirfile

Command to display dirfilename manual in Linux: $ man 3 dirfilename

NAME

dirfilename --- retrieve the name of a dirfile

SYNOPSIS

#include <getdata.h>

const char *dirfilename(const DIRFILE *dirfile);

DESCRIPTION

The dirfilename() function queries a dirfile(5) database specified by dirfile and returns its name. The name of a dirfile is the pathname passed to dirfile_cbopen() or dirfile_open() when the dirfile was opened.

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

RETURN VALUE

Upon successful completion, dirfilename() returns a pointer to a constant string containing the pathname of the dirfile. On error, 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 get_error(3). A descriptive error string for the last error encountered can be obtained from a call to get_error_string(3).