gd_naliases man page

gd_naliases — report the number of aliases of a field in a Dirfile

Synopsis

#include <getdata.h>

unsigned int gd_naliases(DIRFILE *dirfile, const char *field_code);

Description

The gd_naliases() function queries a dirfile(5) database specified by dirfile and counts the number of aliases of the entry (including the entry's name) specified by field_code.

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_naliases() returns an unsigned integer indicating the number of aliases of the specified field code in the dirfile.  If successful, this count will be at least one.

On error, this function returns zero 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_CODE

The supplied field code was not found in the database.

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 gd_naliases() function appeared in GetData-0.8.0.

See Also

gd_aliases(3), gd_alias_target(3), gd_open(3), dirfile(5)

Referenced By

gd_aliases(3).

25 December 2016 Version 0.10.0 GETDATA