genders_index_attrvals(3) [debian man page]

GENDERS_INDEX_NODES(3)						    LIBGENDERS						    GENDERS_INDEX_NODES(3)

NAME

       genders_index_attrvals - internally index attribute values in genders

SYNOPSIS

       #include <genders.h>

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

DESCRIPTION

       genders_index_attrvals()  internally  indexes attribute values in a genders handle so that genders searches can be done more quickly in the
       genders_getnodes(3) and genders_isattrval(3) functions.

       Only one attribute can be indexed at a time through this function.  Subsequent calls to this function with a different attribute will over-
       write earlier indexes.

RETURN VALUES

       On  success,  0	is returned.  On error, -1 is returned, and an error code is returned in handle.  The error code can be retrieved via gen-
       ders_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_NOTFOUND
	      The attribute pointed to by attr cannot be found in the genders file.

       GENDERS_ERR_OUTMEM
	      malloc(3) has failed internally, system is out of memory.

       GENDERS_ERR_MAGIC
	      handle has an incorrect magic number.  handle does not point to a genders handle	or  handle  has  been  destroyed  by  genders_han-
	      dle_destroy(3).

       GENDERS_ERR_INTERNAL
	      An internal system error has occurred.

FILES

       /usr/include/genders.h

SEE ALSO

       libgenders(3),  genders_handle_create(3),  genders_load_data(3), genders_getnodes(3), genders_isattrval(3), genders_errnum(3), genders_str-
       error(3)

LLNL
								    August 2003 					    GENDERS_INDEX_NODES(3)

GENDERS_ISNODE(3)						    LIBGENDERS							 GENDERS_ISNODE(3)

NAME

       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_han-
	      dle_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)

LLNL
								    August 2003 						 GENDERS_ISNODE(3)