Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

genders_index_attrvals (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_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 gen-
       ders 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  cre-
              ated 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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | library/libgenders    |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
SEE ALSO
       libgenders(3),  genders_handle_create(3),  genders_load_data(3),   gen-
       ders_getnodes(3), genders_isattrval(3), genders_errnum(3), genders_str-
       error(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source     was      downloaded      from       http://downloads.source-
       forge.net/project/genders/genders/1.22-1/genders-1.22.tar.gz

       Further information about this software can be found on the open source
       community website at https://github.com/chaos/genders.



LLNL                              August 2003           GENDERS_INDEX_NODES(3)