1GENDERS_INDEX_NODES(3)            LIBGENDERS            GENDERS_INDEX_NODES(3)
2
3
4

NAME

6       genders_index_attrvals - internally index attribute values in genders
7

SYNOPSIS

9       #include <genders.h>
10
11       int genders_index_attrvals(genders_t handle, const char *attr);
12
13

DESCRIPTION

15       genders_index_attrvals()  internally indexes attribute values in a gen‐
16       ders handle so that genders searches can be done more  quickly  in  the
17       genders_getnodes(3) and genders_isattrval(3) functions.
18
19       Only  one  attribute  can  be  indexed at a time through this function.
20       Subsequent calls to this function with a different attribute will over‐
21       write earlier indexes.
22

RETURN VALUES

24       On success, 0 is returned.  On error, -1 is returned, and an error code
25       is returned in handle.  The  error  code  can  be  retrieved  via  gen‐
26       ders_errnum(3)  ,  and a description of the error code can be retrieved
27       via genders_strerror(3).  Error codes are defined in genders.h.
28

ERRORS

30       GENDERS_ERR_NULLHANDLE
31              The handle parameter is NULL.  The genders handle must  be  cre‐
32              ated with genders_handle_create(3).
33
34       GENDERS_ERR_NOTLOADED
35              genders_load_data(3) has not been called to load genders data.
36
37       GENDERS_ERR_PARAMETERS
38              An incorrect parameter has been passed in.
39
40       GENDERS_ERR_NOTFOUND
41              The  attribute pointed to by attr cannot be found in the genders
42              file.
43
44       GENDERS_ERR_OUTMEM
45              malloc(3) has failed internally, system is out of memory.
46
47       GENDERS_ERR_MAGIC
48              handle has an incorrect magic number.  handle does not point  to
49              a  genders  handle  or handle has been destroyed by genders_han‐
50              dle_destroy(3).
51
52       GENDERS_ERR_INTERNAL
53              An internal system error has occurred.
54

FILES

56       /usr/include/genders.h
57

SEE ALSO

59       libgenders(3),  genders_handle_create(3),  genders_load_data(3),   gen‐
60       ders_getnodes(3), genders_isattrval(3), genders_errnum(3), genders_str‐
61       error(3)
62
63
64
65LLNL                              August 2003           GENDERS_INDEX_NODES(3)
Impressum