Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

genders_getnodename (3)

Name

genders_getnodename - get the current node name

Synopsis

#include <genders.h>

int genders_getnodename(genders_t handle, char *node, int len);

Description

GENDERS_GETNODENAME(3)            LIBGENDERS            GENDERS_GETNODENAME(3)



NAME
       genders_getnodename - get the current node name

SYNOPSIS
       #include <genders.h>

       int genders_getnodename(genders_t handle, char *node, int len);

DESCRIPTION
       genders_getnodename()  retrieves the name of the node that the function
       is being called from.  The node name returned is the shortened hostname
       of the node and is stored in the buffer pointed to be node.  len should
       indicate the length of the buffer.  The node returned by  genders_getn-
       odename() is the shortened hostname of the node.

       To avoid passing in a buffer that is not large enough to store the node
       name, genders_getmaxnodelen(3) should be used to determine the  minimum
       buffer size that should be used.

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_OVERFLOW
              The  buffer  pointed to by node is not large enough to store the
              node name.

       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


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_getmaxnodelen(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_GETNODENAME(3)