Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

genders_getattr_all (3)

Name

genders_getattr_all - get all the attributes stored in a genders file

Synopsis

#include <genders.h>

int genders_getattr_all(genders_t handle, char *attrs[], int len);

Description

GENDERS_GETATTR_ALL(3)            LIBGENDERS            GENDERS_GETATTR_ALL(3)



NAME
       genders_getattr_all - get all the attributes stored in a genders file

SYNOPSIS
       #include <genders.h>

       int genders_getattr_all(genders_t handle, char *attrs[], int len);

DESCRIPTION
       genders_getattr_all() gets all the attributes found in the genders file
       associated with handle.  The attributes are  stored  in  the  attribute
       list  pointed  to by attrs.  len should indicate the number of elements
       that can be stored in the attribute list.

       To avoid passing in a list that is not large enough to  store  all  the
       attributes, genders_getnumattrs(3) should be used to determine the min-
       imum  number  of  elements  attrs  should  be  able  to  store.    gen-
       ders_attrlist_create(3)  could be used to create a list that is guaran-
       teed to be large enough to store all attributes.

RETURN VALUES
       On success, the number of attributes stored in attrs 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 attrs is not large enough to store all
              the attributes.

       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_getnumattrs(3),   genders_attrlist_create(3),   genders_errnum(3),
       genders_strerror(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was   downloaded   from    https://github.com/chaos/genders/ar-
       chive/refs/tags/genders-1-28-1.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_GETATTR_ALL(3)