genders_isnode man page

genders_isnode, genders_isattr, genders_isattrval — node, attribute, value check routines

Synopsis

#include <genders.h>

int genders_isnode(genders_t handle, const char *node);

int genders_isattr(genders_t handle, const char *attr);

int genders_isattrval(genders_t handle, const char *attr, const char *val);

Description

genders_isnode() tests if the node pointed to by node is listed in the genders file. If node is NULL, the current node is tested.

genders_isattr() tests if the attribute pointed to by attr is listed for some node in the genders file.

genders_isattrval() tests if the attribute pointed to by attr is equal to the value pointed to by val for some node in the genders file.

Return Values

For genders_isnode(), if node is listed in the genders file, 1 is returned. If it is not listed, 0 is returned.

For genders_isattr(), if attr is listed in the genders file, 1 is returned. If it is not listed, 0 is returned.

For genders_isattrval(), if attr=val is listed in the genders file, 1 is returned. If it is not listed, 0 is returned.

On error, all three return -1 and an error code is returned in handle. The error code can be retrieved via genders_errnum(3) , and a description of the error code can be retrieved via genders_strerror(3). Error codes are defined in genders.h.

Errors

GENDERS_ERR_NULLHANDLE
The handle parameter is NULL. The genders handle must be created with genders_handle_create(3).
GENDERS_ERR_NOTLOADED
genders_load_data(3) has not been called to load genders data.
GENDERS_ERR_PARAMETERS
An incorrect parameter has been passed in.
GENDERS_ERR_MAGIC
handle has an incorrect magic number. handle does not point to a genders handle or handle has been destroyed by genders_handle_destroy(3).

Files

/usr/include/genders.h

See Also

libgenders(3), genders_handle_create(3), genders_load_data(3), genders_errnum(3), genders_strerror(3)

Referenced By

genders_index_attrvals(3).

genders_isattr(3) and genders_isattrval(3) are aliases of genders_isnode(3).

August 2003 LLNL LIBGENDERS