Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

genders_getnodes (3)

Name

genders_getnodes - get nodes from the genders file

Synopsis

#include <genders.h>

int  genders_getnodes(genders_t  handle,  char *nodes[], int len, const
char *attr, const char *val);

Description

GENDERS_GETNODES(3)               LIBGENDERS               GENDERS_GETNODES(3)



NAME
       genders_getnodes - get nodes from the genders file

SYNOPSIS
       #include <genders.h>

       int  genders_getnodes(genders_t  handle,  char *nodes[], int len, const
       char *attr, const char *val);

DESCRIPTION
       genders_getnodes() gets the names of nodes in  the  genders  file  that
       have  the  attribute  specified by attr and the value specified by val.
       The nodes are stored in the list pointed to by  nodes.   len  indicates
       the  number  of nodes that can be stored in the list.  If attr is NULL,
       genders_getnodes() returns all the nodes listed in  the  genders  file.
       If val is NULL, attribute values are ignored.

       To  avoid  passing  in a list that is not large enough to store all the
       nodes, genders_getnumnodes(3) should be used to determine  the  minimum
       number   of   elements   nodes   should   be   able   to  store.   gen-
       ders_nodelist_create(3) could be used to create a list that is  guaran-
       teed to be large enough to store all of the nodes.

RETURN VALUES
       On success, the number of nodes stored in nodes is returned.  On error,
       -1 is returned, 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 cre-
              ated with genders_handle_create(3).

       GENDERS_ERR_NOTLOADED
              genders_load_data(3) has not been called to load genders data.

       GENDERS_ERR_OVERFLOW
              The list pointed to by nodes is not large enough  to  store  all
              the nodes.

       GENDERS_ERR_PARAMETERS
              An incorrect parameter has been passed in.

       GENDERS_ERR_NULLPTR
              A null pointer has been found in the list 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


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_getnumnodes(3),   genders_nodelist_create(3),   genders_errnum(3),
       genders_strerror(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_GETNODES(3)